committee 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0261ef5b9991afdc79316a4aa67e05293b5cc0dc83a8b7dc80a330fcc2d633b9
-  data.tar.gz: a67badbaa49fa492e9bd562293666734a9c733a9d5fa8c54b6a7cf6b3a414305
+  metadata.gz: 169dfa8f079626447ca5086429c0bd025d8180f3ef5b7a7194d1333bdeff8fab
+  data.tar.gz: 2c8eeece5b411266f482808b7caf08d2de285f64e78e705990a4b7b9606902d3
 SHA512:
-  metadata.gz: 8de3637d5059cb2dee41b9d78aa6b448d3c60fc246485bca06cbceb1e2f993c8b86f9d76a9388359c1f05b05e429eaf5949d6e6dfd587246ac4ab8c59f0f37bd
-  data.tar.gz: 510f84e62e9f52239845130b14a6f9432bc2c391c92ab5334b74b301c9119378a491add7f7cfb33fd711a522b727da325a045be31e04ac94fd8c0ead858042a6
+  metadata.gz: b891ea4d1498b2fc16f0d241520486736b0b707bf401e96bdab09795ff165c23d86344a2b29cfcf1dbca83d8a773b85a08e59dc09220c5acca2738e485c3994f
+  data.tar.gz: ca657dfb18edaf157cb01ca48b522882c165a8c06216c84deda9a88a7718fb61da4ea3a3b017e4ac8594e83f97f904d4f0f1ad1947ee9418b977ddf4884e8c52

data/bin/committee-stub

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'optparse'
 require 'yaml'

data/lib/committee.rb

@@ -1,43 +1,11 @@
+# frozen_string_literal: true
+
 require "json"
 require "yaml"
 require "json_schema"
 require "rack"
 require 'openapi_parser'
 
-require_relative "committee/errors"
-require_relative "committee/request_unpacker"
-
-require_relative "committee/validation_error"
-
-require_relative "committee/drivers"
-require_relative "committee/drivers/hyper_schema"
-require_relative "committee/drivers/open_api_2"
-require_relative "committee/drivers/open_api_3"
-
-require_relative "committee/middleware/base"
-require_relative "committee/middleware/request_validation"
-require_relative "committee/middleware/response_validation"
-require_relative "committee/middleware/stub"
-
-require_relative "committee/schema_validator/option"
-require_relative "committee/schema_validator/schema_validator"
-require_relative "committee/schema_validator/open_api_3"
-require_relative "committee/schema_validator/open_api_3/router"
-require_relative "committee/schema_validator/open_api_3/operation_wrapper"
-require_relative "committee/schema_validator/open_api_3/request_validator"
-require_relative "committee/schema_validator/open_api_3/response_validator"
-require_relative "committee/schema_validator/hyper_schema"
-require_relative "committee/schema_validator/hyper_schema/request_validator"
-require_relative "committee/schema_validator/hyper_schema/response_generator"
-require_relative "committee/schema_validator/hyper_schema/response_validator"
-require_relative "committee/schema_validator/hyper_schema/router"
-require_relative "committee/schema_validator/hyper_schema/string_params_coercer"
-require_relative "committee/schema_validator/hyper_schema/parameter_coercer"
-
-require_relative "committee/bin/committee_stub"
-
-require_relative "committee/test/methods"
-
 module Committee
   def self.debug?
     ENV["COMMITTEE_DEBUG"]
@@ -53,3 +21,13 @@ module Committee
     end
   end
 end
+
+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"

data/lib/committee/bin/committee_stub.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Don't Support OpenAPI3
 
 module Committee
@@ -29,10 +31,10 @@ module Committee
       # Gets an option parser for command line arguments.
       def get_options_parser
         options = {
-          :driver   => nil,
-          :help     => false,
-          :port     => 9292,
-          :tolerant => false,
+          driver: nil,
+          help: false,
+          port: 9292,
+          tolerant: false,
         }
 
         parser = OptionParser.new do |opts|

data/lib/committee/drivers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Committee
   module Drivers
     # Gets a driver instance from the specified name. Raises ArgumentError for
@@ -5,11 +7,11 @@ module Committee
     def self.driver_from_name(name)
       case name
       when :hyper_schema
-        Committee::Drivers::HyperSchema.new
+        Committee::Drivers::HyperSchema::Driver.new
       when :open_api_2
-        Committee::Drivers::OpenAPI2.new
+        Committee::Drivers::OpenAPI2::Driver.new
       when :open_api_3
-        Committee::Drivers::OpenAPI3.new
+        Committee::Drivers::OpenAPI3::Driver.new
       else
         raise ArgumentError, %{Committee: unknown driver "#{name}".}
       end
@@ -49,76 +51,22 @@ module Committee
     def self.load_from_data(hash)
       if hash['openapi']&.start_with?('3.0.')
         parser = OpenAPIParser.parse(hash)
-        return Committee::Drivers::OpenAPI3.new.parse(parser)
+        return Committee::Drivers::OpenAPI3::Driver.new.parse(parser)
       end
 
       driver = if hash['swagger'] == '2.0'
-                 Committee::Drivers::OpenAPI2.new
+                 Committee::Drivers::OpenAPI2::Driver.new
                else
-                 Committee::Drivers::HyperSchema.new
+                 Committee::Drivers::HyperSchema::Driver.new
                end
 
       driver.parse(hash)
     end
-
-    # Driver is a base class for driver implementations.
-    class Driver
-      # Whether parameters that were form-encoded will be coerced by default.
-      def default_coerce_form_params
-        raise "needs implementation"
-      end
-
-      # Use GET request body to request parameter (request body merge to parameter)
-      def default_allow_get_body
-        raise "needs implementation"
-      end
-
-      # Whether parameters in a request's path will be considered and coerced
-      # by default.
-      def default_path_params
-        raise "needs implementation"
-      end
-
-      # Whether parameters in a request's query string will be considered and
-      # coerced by default.
-      def default_query_params
-        raise "needs implementation"
-      end
-
-      def name
-        raise "needs implementation"
-      end
-
-      # Parses an API schema and builds a set of route definitions for use with
-      # Committee.
-      #
-      # The expected input format is a data hash with keys as strings (as
-      # opposed to symbols) like the kind produced by JSON.parse or YAML.load.
-      def parse(data)
-        raise "needs implementation"
-      end
-
-      def schema_class
-        raise "needs implementation"
-      end
-    end
-
-    # Schema is a base class for driver schema implementations.
-    class Schema
-      # A link back to the derivative instace of Committee::Drivers::Driver
-      # that create this schema.
-      def driver
-        raise "needs implementation"
-      end
-
-      def build_router(options)
-        raise "needs implementation"
-      end
-
-      # Stubs are supported in JSON Hyper-Schema and OpenAPI 2, but not yet in OpenAPI 3
-      def supports_stub?
-        true
-      end
-    end
   end
-end
+end
+
+require_relative "drivers/driver"
+require_relative "drivers/schema"
+require_relative "drivers/hyper_schema"
+require_relative "drivers/open_api_2"
+require_relative "drivers/open_api_3"

data/lib/committee/drivers/driver.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Committee
+  module Drivers
+    # Driver is a base class for driver implementations.
+    class Driver
+      # Whether parameters that were form-encoded will be coerced by default.
+      def default_coerce_form_params
+        raise "needs implementation"
+      end
+
+      # Use GET request body to request parameter (request body merge to parameter)
+      def default_allow_get_body
+        raise "needs implementation"
+      end
+
+      # Whether parameters in a request's path will be considered and coerced
+      # by default.
+      def default_path_params
+        raise "needs implementation"
+      end
+
+      # Whether parameters in a request's query string will be considered and
+      # coerced by default.
+      def default_query_params
+        raise "needs implementation"
+      end
+
+      def name
+        raise "needs implementation"
+      end
+
+      # Parses an API schema and builds a set of route definitions for use with
+      # Committee.
+      #
+      # The expected input format is a data hash with keys as strings (as
+      # opposed to symbols) like the kind produced by JSON.parse or YAML.load.
+      def parse(data)
+        raise "needs implementation"
+      end
+
+      def schema_class
+        raise "needs implementation"
+      end
+    end
+  end
+end

data/lib/committee/drivers/hyper_schema.rb

@@ -1,175 +1,12 @@
-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
-    end
-
-    def default_allow_get_body
-      true
-    end
-
-    # Whether parameters in a request's path will be considered and coerced by
-    # default.
-    def default_path_params
-      false
-    end
-
-    # Whether parameters in a request's query string will be considered and
-    # coerced by default.
-    def default_query_params
-      false
-    end
-
-    def default_validate_success_only
-      true
-    end
-
-    def name
-      :hyper_schema
-    end
-
-    # Parses an API schema and builds a set of route definitions for use with
-    # Committee.
-    #
-    # The expected input format is a data hash with keys as strings (as opposed
-    # to symbols) like the kind produced by JSON.parse or YAML.load.
-    def parse(schema)
-      # Really we'd like to only have data hashes passed into drivers these
-      # days, but here we handle a JsonSchema::Schema for now to maintain
-      # backward compatibility (this library used to be hyper-schema only).
-      if schema.is_a?(JsonSchema::Schema)
-        hyper_schema = schema
-      else
-        hyper_schema = JsonSchema.parse!(schema)
-        hyper_schema.expand_references!
-      end
-
-      schema = Schema.new
-      schema.driver = self
-      schema.routes = build_routes(hyper_schema)
-      schema
-    end
+# frozen_string_literal: true
 
-    def schema_class
-      Committee::Drivers::HyperSchema::Schema
-    end
-
-    # Link abstracts an API link specifically for JSON hyper-schema.
-    #
-    # For most operations, it's a simple pass through to a
-    # JsonSchema::Schema::Link, but implements some exotic behavior in a few
-    # places.
-    class Link
-      def initialize(hyper_schema_link)
-        self.hyper_schema_link = hyper_schema_link
-      end
-
-      # The link's input media type. i.e. How requests should be encoded.
-      def enc_type
-        hyper_schema_link.enc_type
-      end
-
-      def href
-        hyper_schema_link.href
-      end
-
-      # The link's output media type. i.e. How responses should be encoded.
-      def media_type
-        hyper_schema_link.media_type
-      end
-
-      def method
-        hyper_schema_link.method
-      end
-
-      # Passes through a link's parent resource. Note that this is *not* part
-      # of the Link interface and is here to support a legacy Heroku-ism
-      # behavior that allowed a link tagged with rel=instances to imply that a
-      # list will be returned.
-      def parent
-        hyper_schema_link.parent
-      end
-
-      def rel
-        hyper_schema_link.rel
-      end
-
-      # The link's input schema. i.e. How we validate an endpoint's incoming
-      # parameters.
-      def schema
-        hyper_schema_link.schema
-      end
-
-      def status_success
-        hyper_schema_link.rel == "create" ? 201 : 200
-      end
-
-      # The link's output schema. i.e. How we validate an endpoint's response
-      # data.
-      def target_schema
-        hyper_schema_link.target_schema
-      end
-
-      private
-
-      attr_accessor :hyper_schema_link
-    end
-
-    class Schema < Committee::Drivers::Schema
-      # A link back to the derivative instace of Committee::Drivers::Driver
-      # that create this schema.
-      attr_accessor :driver
-
-      attr_accessor :routes
-
-      attr_reader :validator_option
-
-      def build_router(options)
-        @validator_option = Committee::SchemaValidator::Option.new(options, self, :hyper_schema)
-        Committee::SchemaValidator::HyperSchema::Router.new(self, @validator_option)
-      end
-    end
-
-    private
-
-    def build_routes(hyper_schema)
-      routes = {}
-
-      hyper_schema.links.each do |link|
-        method, href = parse_link(link)
-        next unless method
-
-        rx = %r{^#{href}$}
-        Committee.log_debug "Created route: #{method} #{href} (regex #{rx})"
-
-        routes[method] ||= []
-        routes[method] << [rx, Link.new(link)]
-      end
-
-      # recursively iterate through all `properties` subschemas to build a
-      # complete routing table
-      hyper_schema.properties.each do |_, subschema|
-        routes.merge!(build_routes(subschema)) { |_, r1, r2| r1 + r2 }
-      end
-
-      routes
-    end
-
-    def href_to_regex(href)
-      href.gsub(/\{(.*?)\}/, "[^/]+")
-    end
-
-    def parse_link(link)
-      return nil, nil if !link.method || !link.href
-      method = link.method.to_s.upcase
-      # /apps/{id} --> /apps/([^/]+)
-      href = href_to_regex(link.href)
-      [method, href]
+module Committee
+  module Drivers
+    module HyperSchema
     end
   end
 end
+
+require_relative 'hyper_schema/driver'
+require_relative 'hyper_schema/link'
+require_relative 'hyper_schema/schema'

data/lib/committee/drivers/hyper_schema/driver.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Committee
+  module Drivers
+    module HyperSchema
+      class Driver < ::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
+        end
+
+        def default_allow_get_body
+          true
+        end
+
+        # Whether parameters in a request's path will be considered and coerced by
+        # default.
+        def default_path_params
+          false
+        end
+
+        # Whether parameters in a request's query string will be considered and
+        # coerced by default.
+        def default_query_params
+          false
+        end
+
+        def default_validate_success_only
+          true
+        end
+
+        def name
+          :hyper_schema
+        end
+
+        # Parses an API schema and builds a set of route definitions for use with
+        # Committee.
+        #
+        # The expected input format is a data hash with keys as strings (as opposed
+        # to symbols) like the kind produced by JSON.parse or YAML.load.
+        def parse(schema)
+          # Really we'd like to only have data hashes passed into drivers these
+          # days, but here we handle a JsonSchema::Schema for now to maintain
+          # backward compatibility (this library used to be hyper-schema only).
+          if schema.is_a?(JsonSchema::Schema)
+            hyper_schema = schema
+          else
+            hyper_schema = JsonSchema.parse!(schema)
+            hyper_schema.expand_references!
+          end
+
+          schema = Schema.new
+          schema.driver = self
+          schema.routes = build_routes(hyper_schema)
+          schema
+        end
+
+        def schema_class
+          Committee::Drivers::HyperSchema::Schema
+        end
+
+        private
+
+        def build_routes(hyper_schema)
+          routes = {}
+
+          hyper_schema.links.each do |link|
+            method, href = parse_link(link)
+            next unless method
+
+            rx = %r{^#{href}$}
+            Committee.log_debug "Created route: #{method} #{href} (regex #{rx})"
+
+            routes[method] ||= []
+            routes[method] << [rx, Link.new(link)]
+          end
+
+          # recursively iterate through all `properties` subschemas to build a
+          # complete routing table
+          hyper_schema.properties.each do |_, subschema|
+            routes.merge!(build_routes(subschema)) { |_, r1, r2| r1 + r2 }
+          end
+
+          routes
+        end
+
+        def href_to_regex(href)
+          href.gsub(/\{(.*?)\}/, "[^/]+")
+        end
+
+        def parse_link(link)
+          return nil, nil if !link.method || !link.href
+          method = link.method.to_s.upcase
+          # /apps/{id} --> /apps/([^/]+)
+          href = href_to_regex(link.href)
+          [method, href]
+        end
+      end
+    end
+  end
+end