committee 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19ffd2ac55e6c3099fa3847fdf10b34028ef3cca
-  data.tar.gz: 88b45587d79f604c951e0a9a827454d7471a5e8b
+  metadata.gz: 80631a912a39fd3bfe5334456acb5c6dcaf8a30a
+  data.tar.gz: 61ded3be6affcb5f842a168a27823bc646f00776
 SHA512:
-  metadata.gz: 5bd74c2990fd147c4d2d0556b0902123177b8072ee1911e0d410c2218a182187a4f2a8851c9a8826589a885327763a566f996884b6de8cf94facf800388462c2
-  data.tar.gz: c2b15f8dd3c81660ccbb6836395ccae85eb36b337c4f123546ab2b4a7d1ae7f99671fee0b2f796819819f5d1838a6f203a0722a15ab34e37e3712471ec5d9acd
+  metadata.gz: 51cd02c1fedb4fa660e88e3f1d56580a3d3c425e8cb0736903ed6b50a7564ff0e46a4a5aa447af7077132893f1b174e6e4becff245edd80d73da6f961adf04bb
+  data.tar.gz: 735ce3684a203194307b638c35201fbd59aaef38813ffa7e076fc17e6ee3ddc7fc3c954cba93930d5ef7e263149fa90c776c70beeba821e81e077e9f1052a47e

data/lib/committee/middleware/base.rb

@@ -11,7 +11,17 @@ module Committee::Middleware
       end
       @schema = JsonSchema.parse!(data)
       @schema.expand_references!
-      @router = Committee::Router.new(@schema)
+      @router = Committee::Router.new(@schema, options)
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+
+      if @router.includes_request?(request)
+        handle(request)
+      else
+        @app.call(request.env)
+      end
     end
 
     private

data/lib/committee/middleware/request_validation.rb

@@ -2,7 +2,6 @@ module Committee::Middleware
   class RequestValidation < Base
     def initialize(app, options={})
       super
-      @prefix = options[:prefix]
       @raise  = options[:raise]
       @strict = options[:strict]
 
@@ -10,19 +9,17 @@ module Committee::Middleware
       @allow_extra = options[:allow_extra]
     end
 
-    def call(env)
-      request = Rack::Request.new(env)
-      env[@params_key] = Committee::RequestUnpacker.new(request).call
-      if link = @router.routes_request?(request, prefix: @prefix)
+    def handle(request)
+      request.env[@params_key] = Committee::RequestUnpacker.new(request).call
+
+      if link = @router.find_request_link(request)
         validator = Committee::RequestValidator.new(link)
-        validator.call(request, env[@params_key])
-        @app.call(env)
+        validator.call(request, request.env[@params_key])
+        @app.call(request.env)
+      elsif @strict
+        raise Committee::NotFound
       else
-        if @strict
-          raise Committee::NotFound
-        else
-          @app.call(env)
-        end
+        @app.call(request.env)
       end
     rescue Committee::BadRequest, Committee::InvalidRequest
       raise if @raise

data/lib/committee/middleware/response_validation.rb

@@ -2,14 +2,13 @@ module Committee::Middleware
   class ResponseValidation < Base
     def initialize(app, options={})
       super
-      @prefix = options[:prefix]
       @raise  = options[:raise]
     end
 
-    def call(env)
-      status, headers, response = @app.call(env)
-      request = Rack::Request.new(env)
-      if link = @router.routes_request?(request, prefix: @prefix)
+    def handle(request)
+      status, headers, response = @app.call(request.env)
+
+      if link = @router.find_request_link(request)
         full_body = ""
         response.each do |chunk|
           full_body << chunk

data/lib/committee/middleware/stub.rb

@@ -3,23 +3,21 @@ module Committee::Middleware
     def initialize(app, options={})
       super
       @cache = {}
-      @call   = options[:call]
-      @prefix = options[:prefix]
+      @call  = options[:call]
     end
 
-    def call(env)
-      request = Rack::Request.new(env)
-      if link = @router.routes_request?(request, prefix: @prefix)
+    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
-          env["committee.response"] = data
-          call_status, call_headers, call_body = @app.call(env)
+          request.env["committee.response"] = data
+          call_status, call_headers, call_body = @app.call(request.env)
 
           # a committee.suppress signal initiates a direct pass through
-          if env["committee.suppress"] == true
+          if request.env["committee.suppress"] == true
             return call_status, call_headers, call_body
           end
 
@@ -30,7 +28,7 @@ module Committee::Middleware
         status = link.rel == "create" ? 201 : 200
         [status, headers, [MultiJson.encode(data, pretty: true)]]
       else
-        @app.call(env)
+        @app.call(request.env)
       end
     end
 

data/lib/committee/router.rb

@@ -1,11 +1,21 @@
 module Committee
   class Router
-    def initialize(schema)
+    def initialize(schema, options = {})
       @routes = build_routes(schema)
+      @prefix = options[:prefix]
+      @prefix_regexp = /\A#{Regexp.escape(@prefix)}/.freeze if @prefix
     end
 
-    def routes?(method, path, options = {})
-      path = path.gsub(/^#{options[:prefix]}/, "") if options[:prefix]
+    def includes?(path)
+      !@prefix || path =~ @prefix_regexp
+    end
+
+    def includes_request?(request)
+      includes?(request.path)
+    end
+
+    def find_link(method, path)
+      path = path.gsub(@prefix_regexp, "") if @prefix
       if method_routes = @routes[method]
         method_routes.each do |pattern, link|
           if path =~ pattern
@@ -16,8 +26,8 @@ module Committee
       nil
     end
 
-    def routes_request?(request, options = {})
-      routes?(request.request_method, request.path_info, options)
+    def find_request_link(request)
+      find_link(request.request_method, request.path_info)
     end
 
     private

data/lib/committee/test/methods.rb

@@ -11,11 +11,9 @@ module Committee::Test
         schema.expand_references!
         schema
       end
-      @router ||= Committee::Router.new(@schema)
+      @router ||= Committee::Router.new(@schema, prefix: schema_url_prefix)
 
-      link =
-        @router.routes_request?(last_request, prefix: schema_url_prefix)
-      unless link
+      unless link = @router.find_request_link(last_request)
         response = "`#{last_request.request_method} #{last_request.path_info}` undefined in schema."
         raise Committee::InvalidResponse.new(response)
       end

data/test/middleware/request_validation_test.rb

@@ -46,6 +46,13 @@ describe Committee::Middleware::RequestValidation do
     assert_equal 200, last_response.status
   end
 
+  it "ignores paths outside the prefix" do
+    @app = new_rack_app(prefix: "/v1")
+    header "Content-Type", "text/html"
+    get "/hello"
+    assert_equal 200, last_response.status
+  end
+
   it "warns when sending a deprecated string" do
     mock(Committee).warn_deprecated.with_any_args
     @app = new_rack_app(schema: File.read("./test/data/schema.json"))

data/test/router_test.rb

@@ -1,27 +1,38 @@
 require_relative "test_helper"
 
 describe Committee::Router do
-  before do
-    data = MultiJson.decode(File.read("./test/data/schema.json"))
-    schema = JsonSchema.parse!(data)
-    schema.expand_references!
-    @router = Committee::Router.new(schema)
-  end
-
   it "builds routes without parameters" do
-    refute_nil @router.routes?("GET", "/apps")
+    refute_nil router.find_link("GET", "/apps")
   end
 
   it "builds routes with parameters" do
-    refute_nil @router.routes?("GET", "/apps/123")
+    refute_nil router.find_link("GET", "/apps/123")
   end
 
   it "doesn't match anything on a /" do
-    assert_nil @router.routes?("GET", "/")
+    assert_nil router.find_link("GET", "/")
   end
 
   it "takes a prefix" do
     # this is a sociopathic example
-    refute_nil @router.routes?("GET", "/kpi/apps/123", prefix: "/kpi")
+    assert router(prefix: "/kpi").find_link("GET", "/kpi/apps/123")
+  end
+
+  it "includes all paths without a prefix" do
+    assert router.includes?("/")
+    assert router.includes?("/apps")
+  end
+
+  it "only includes the prefix path with a prefix" do
+    refute router(prefix: "/kpi").includes?("/")
+    assert router(prefix: "/kpi").includes?("/kpi")
+    assert router(prefix: "/kpi").includes?("/kpi/apps")
+  end
+
+  def router(options = {})
+    data = MultiJson.decode(File.read("./test/data/schema.json"))
+    schema = JsonSchema.parse!(data)
+    schema.expand_references!
+    Committee::Router.new(schema, options)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: committee
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Brandur