api_valve 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fdf08e3fa15d2bb46dc6f85ee53c681b696d574585b6be1e11dc7fc6b6527b1
-  data.tar.gz: 3cf720502939fe562d385a7347e681927e79519446111410f6ba8c8f1ad7fb52
+  metadata.gz: 8f4cba9301dc5313a548d0d0be717b8bbc0af686c5da846bac838547e08dd8e3
+  data.tar.gz: 42d48117b5969d38f5125bfa4fbbde0633fbde1214b738de1efd607007cbb978
 SHA512:
-  metadata.gz: 7e635bcd48b26f59cb92cd46551eb2b4de46fc23765a80c826c7f65993f52dfd232dceb4538586026c73a7d538a591aec96ffd681362c4f5ce1a3d9fbcf944a9
-  data.tar.gz: 2543e426f0b25a9a3b0c1970f3e4dfc81e9d01ccc6147888438d28bff60dca3c9768f98b9e98c4aaf49b090206df93616632a1f559e0454511b8dd83e9953fe7
+  metadata.gz: 537cfb673ad5a8eeb6ec9f0871a0a85d6b61206326e0c9f0f4731414f341f60c45b595feab392f86ab4ea00c64819f83c3b7b98c2650a40e318e22bf1e812a64
+  data.tar.gz: f7e6538270b6d444c1bdf4b1fe06f9d86864c61ca1d9738201d21f9eb06c6349888e4141756ef5db7afdc63a9c427985a64d8d7c306d783d9740ad04d8934743

data/lib/api_valve.rb

@@ -17,17 +17,14 @@ module ApiValve
   autoload :Error,          'api_valve/error'
   autoload :ErrorResponder, 'api_valve/error_responder'
   autoload :Forwarder,      'api_valve/forwarder'
+  autoload :Middleware,     'api_valve/middleware'
   autoload :Logger,         'api_valve/logger'
   autoload :Proxy,          'api_valve/proxy'
-  autoload :Router,         'api_valve/router'
+  autoload :RouteSet,       'api_valve/route_set'
+  autoload :Runner,         'api_valve/runner'
 
   include ActiveSupport::Configurable
 
-  module Middleware
-    autoload :ErrorHandling, 'api_valve/middleware/error_handling'
-    autoload :Logging,       'api_valve/middleware/logging'
-  end
-
   config_accessor :logger do
     Logger.new(STDOUT)
   end

data/lib/api_valve/middleware.rb

@@ -0,0 +1,43 @@
+module ApiValve
+  class Middleware
+    autoload :ErrorHandling, 'api_valve/middleware/error_handling'
+    autoload :Logging,       'api_valve/middleware/logging'
+    autoload :Router,        'api_valve/middleware/router'
+
+    Item = Struct.new(:klass, :proc)
+
+    def initialize
+      @registry = []
+    end
+
+    def insert_after(other, middleware, *args, &block)
+      @registry.insert position(other) + 1, to_item(middleware, *args, &block)
+    end
+
+    def insert_before(other, middleware, *args, &block)
+      @registry.insert position(other), to_item(middleware, *args, &block)
+    end
+
+    def to_app(root_app)
+      @registry.reverse.inject(root_app) { |memo, obj| obj.proc.call memo }
+    end
+
+    def to_s
+      @registry.map(&:klass).join("\n")
+    end
+
+    def use(middleware, *args, &block)
+      @registry << to_item(middleware, *args, &block)
+    end
+
+    private
+
+    def position(klass)
+      @registry.index { |item| item.klass == klass }
+    end
+
+    def to_item(middleware, *args, &block)
+      Item.new(middleware, proc { |app| middleware.new(app, *args, &block) })
+    end
+  end
+end

data/lib/api_valve/middleware/error_handling.rb

@@ -1,23 +1,21 @@
-module ApiValve
-  module Middleware
-    class ErrorHandling
-      def initialize(app)
-        @app = app
-      end
+class ApiValve::Middleware
+  class ErrorHandling
+    def initialize(app)
+      @app = app
+    end
 
-      def call(env)
-        @app.call(env)
-      rescue Exception => e # rubocop:disable Lint/RescueException
-        log_error e
-        self.class.const_get(ApiValve.error_responder).new(e).call
-      end
+    def call(env)
+      @app.call(env)
+    rescue Exception => e # rubocop:disable Lint/RescueException
+      log_error e
+      self.class.const_get(ApiValve.error_responder).new(e).call
+    end
 
-      private
+    private
 
-      def log_error(error)
-        ApiValve.logger.error { "#{error.class}: #{error.message}" }
-        ApiValve.logger.error { error.backtrace.join("\n") }
-      end
+    def log_error(error)
+      ApiValve.logger.error { "#{error.class}: #{error.message}" }
+      ApiValve.logger.error { error.backtrace.join("\n") }
     end
   end
 end

data/lib/api_valve/middleware/logging.rb

@@ -1,4 +1,4 @@
-module ApiValve::Middleware
+class ApiValve::Middleware
   class Logging
     include ActiveSupport::Configurable
 

data/lib/api_valve/middleware/router.rb

@@ -0,0 +1,15 @@
+class ApiValve::Middleware
+  class Router
+    def initialize(app, routeset)
+      @app = app
+      @routeset = routeset
+    end
+
+    def call(env)
+      route, match_data = @routeset.match env
+      env['api_valve.router.route'] = route
+      env['api_valve.router.match_data'] = match_data
+      @app.call(env)
+    end
+  end
+end

data/lib/api_valve/proxy.rb

@@ -64,22 +64,25 @@ module ApiValve
       end
     end
 
-    attr_reader :request, :forwarder, :router
+    attr_reader :request, :forwarder, :middleware, :route_set
+
+    alias router route_set
 
     def initialize(forwarder)
       @forwarder = forwarder
-      @router = Router.new
-      @middlewares = []
+      @route_set = RouteSet.new
+      @middleware = Middleware.new
+      use Middleware::Router, route_set
     end
 
     def call(env)
-      stack = @middlewares.reverse.inject(@router) { |a, e| e.call a }
-      stack.call(env)
+      to_app.call(env)
     rescue ApiValve::Error::Client, ApiValve::Error::Server => e
       render_error e
     end
 
-    delegate :add_route, to: :router
+    delegate :add_route, to: :route_set
+    delegate :use, to: :middleware
 
     def build_routes_from_config(routes_config)
       return forward_all unless routes_config
@@ -97,32 +100,32 @@ module ApiValve
 
     def forward(methods, path_regexp = nil, request_override = {})
       Array.wrap(methods).each do |method|
-        router.public_send(method, path_regexp, proc { |request, match_data|
+        route_set.public_send(method, path_regexp, proc { |request, match_data|
           forwarder.call request, {'match_data' => match_data}.merge(request_override || {})
         })
       end
     end
 
     def forward_all
-      router.any do |request, match_data|
+      route_set.any do |request, match_data|
         forwarder.call request, 'match_data' => match_data
       end
     end
 
     def deny(methods, path_regexp = nil, with: 'Error::Forbidden')
       Array.wrap(methods).each do |method|
-        router.public_send(method, path_regexp, ->(*_args) { raise ApiValve.const_get(with) })
+        route_set.public_send(method, path_regexp, ->(*_args) { raise ApiValve.const_get(with) })
       end
     end
 
-    def use(middleware, *args, &block)
-      @middlewares << proc { |app| middleware.new(app, *args, &block) }
-    end
-
     protected
 
     def render_error(error)
       self.class.const_get(ApiValve.error_responder).new(error).call
     end
+
+    def to_app
+      @to_app ||= @middleware.to_app(Runner.new)
+    end
   end
 end

data/lib/api_valve/{router.rb → route_set.rb}

@@ -1,5 +1,5 @@
 module ApiValve
-  class Router
+  class RouteSet
     METHODS = %i(get post put patch delete head).freeze
 
     Route = Struct.new(:regexp, :block) do
@@ -16,8 +16,20 @@ module ApiValve
       reset_routes
     end
 
-    def call(env)
-      match Rack::Request.new(env)
+    def match(env)
+      request = Rack::Request.new(env)
+
+      # For security reasons do not allow URLs that could break out of the proxy namespace on the
+      # server. Preferably an nxing/apache rewrite will kill these URLs before they hit us
+      raise 'URL not supported' if request.path_info.include?('/../')
+
+      match_data = nil
+      route = @routes && @routes[request.request_method.downcase.to_sym].find do |r|
+        (match_data = r.match(request.path_info))
+      end
+      raise Error::NotRouted, 'Endpoint not found' unless route
+
+      [route, match_data]
     end
 
     def delete(path = nil, prok = nil)
@@ -65,20 +77,5 @@ module ApiValve
     def reset_routes
       @routes = Hash[METHODS.map { |v| [v, []] }].freeze
     end
-
-    private
-
-    def match(request)
-      # For security reasons do not allow URLs that could break out of the proxy namespace on the
-      # server. Preferably an nxing/apache rewrite will kill these URLs before they hit us
-      raise 'URL not supported' if request.path_info.include?('/../')
-
-      @routes && @routes[request.request_method.downcase.to_sym].each do |route|
-        if (match_data = route.match(request.path_info))
-          return route.call request, match_data
-        end
-      end
-      raise Error::NotRouted, 'Endpoint not found'
-    end
   end
 end

data/lib/api_valve/runner.rb

@@ -0,0 +1,9 @@
+module ApiValve
+  class Runner
+    def call(env)
+      env['api_valve.router.route'].call \
+        Rack::Request.new(env),
+        env['api_valve.router.match_data']
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_valve
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - mkon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-14 00:00:00.000000000 Z
+date: 2018-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -202,10 +202,13 @@ files:
 - lib/api_valve/forwarder/request.rb
 - lib/api_valve/forwarder/response.rb
 - lib/api_valve/logger.rb
+- lib/api_valve/middleware.rb
 - lib/api_valve/middleware/error_handling.rb
 - lib/api_valve/middleware/logging.rb
+- lib/api_valve/middleware/router.rb
 - lib/api_valve/proxy.rb
-- lib/api_valve/router.rb
+- lib/api_valve/route_set.rb
+- lib/api_valve/runner.rb
 homepage: https://github.com/mkon/api_valve
 licenses:
 - MIT