api_valve 0.7.5 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1e423a6ca2aa1d4c6bc6e5e8f5a08a8bd038b82b5f04900b9a5b6d8c284c3e6
-  data.tar.gz: 0d663952c1afcbc94a2ef45820180d7b678986d625af0c1573636187612d16d3
+  metadata.gz: 747e1a4e8af660cd217bd7a73d8988fda2099e5cd3edcba2941c0688a478a79e
+  data.tar.gz: 146fbd8110cd9331c08aa03befed3a612c4b5ee6b886d4e9e8473d2ba6b91d58
 SHA512:
-  metadata.gz: c8d833a39d15bf5c1d4158148de31a7ac06dac5c9cf76efff652a2aaade2491756c9853f1ef84a6f7d40e6d27c8be80683352a08abffafc6db0c59ad3c827175
-  data.tar.gz: 8e1a25c63606dfe78672ef418f4a419556afccbf770aa4c543e11253f612b8f2d31a0af0feab769a315a8e072076a6dca56319d058e58c6f56fbc4f35039ad1e
+  metadata.gz: 1897f2aac864319f7c42963201000c0840b9b00f2b16533babdf9763f63a4d22f3b50613455f1a6a764b9706c6d6407214ee11f32f73cd7416f94d999086943c
+  data.tar.gz: bc6f4a6be457aa4910c348d3cac84ea08efadc008b2df0b0cd92f104bdc4af77e8ffc0247551cc1cfce856b0627b71983c13faf17ad3b634ed929d7f57eedc56

data/README.md

@@ -18,3 +18,21 @@ gem 'api_valve'
 
 See the [examples](https://github.com/mkon/api_valve/tree/master/examples) section on how to
 create & configure your own proxy using this gem.
+
+### Headers
+
+By default the following headers are forwarded:
+
+* `Accept`
+* `Content-Type`
+* `User-Agent`
+* `X-Real-IP`
+* `X-Request-Id`
+
+Additionally these headers are generated:
+
+* `X-Forwarded-For`: The ApiGateway is added to the list
+* `X-Forwarded-Host`: Filled with original request host
+* `X-Forwarded-Port`: Filled with original request port
+* `X-Forwarded-Prefix`: Filled with the path prefix of the forwarder within the Api Gateway (eg `SCRIPT_NAME` env)
+* `X-Forwarded-Proto`: Filled with original request scheme

data/lib/api_valve/error_responder.rb

@@ -16,7 +16,7 @@ module ApiValve
 
     def status
       status = @error.try(:http_status)
-      return status if status&.is_a?(Integer)
+      return status if status.is_a?(Integer)
 
       Rack::Utils::SYMBOL_TO_STATUS_CODE[status] || 500
     end

data/lib/api_valve/forwarder/request.rb

@@ -76,18 +76,19 @@ module ApiValve
 
     def forwarded_headers
       {
-        'X-Forwarded-For'   => x_forwarded_for,
-        'X-Forwarded-Host'  => original_request.host,
-        'X-Forwarded-Port'  => original_request.port.to_s,
-        'X-Forwarded-Proto' => original_request.scheme
-      }
+        'X-Forwarded-For'    => x_forwarded_for,
+        'X-Forwarded-Host'   => original_request.host,
+        'X-Forwarded-Port'   => original_request.port.to_s,
+        'X-Forwarded-Prefix' => original_request.env['SCRIPT_NAME'].presence,
+        'X-Forwarded-Proto'  => original_request.scheme
+      }.compact
     end
 
     def override_path(options)
       return unless (path = options['path'])
-      return path unless options.dig('match_data')
+      return path unless options['match_data']
 
-      path % options.dig('match_data').named_captures.symbolize_keys
+      path % options['match_data'].named_captures.symbolize_keys
     end
 
     def x_forwarded_for

data/lib/api_valve/logger.rb

@@ -9,7 +9,7 @@ module ApiValve
       include ActiveSupport::TaggedLogging::Formatter
     end
 
-    def initialize(target = STDOUT)
+    def initialize(target = $stdout)
       super(target)
       self.formatter = Formatter.new
     end

data/lib/api_valve/proxy/builder.rb

@@ -1,10 +1,9 @@
 module ApiValve
   class Proxy
     module Builder
-      # Creates a n instance from a config hash and takes optional block
+      # Creates an instance from a config hash and takes optional block
       # which is executed in scope of the proxy
-      def build(config)
-        block = Proc.new if block_given? # capture the yield
+      def build(config, &block)
         from_hash(config).tap do |proxy|
           proxy.instance_eval(&block) if block
         end
@@ -16,7 +15,7 @@ module ApiValve
         raise "Config not found for #{name.underscore}(.yml|.yml.erb) in #{ApiValve.config_paths.inspect}" unless path
 
         yaml = File.read(path)
-        yaml = ERB.new(yaml, nil, '-').result if path.fnmatch? '*.erb'
+        yaml = ERB.new(yaml, trim_mode: '-').result if path.fnmatch? '*.erb'
         from_yaml yaml
       end
 

data/lib/api_valve/proxy.rb

@@ -34,9 +34,9 @@ module ApiValve
 
     def forward(methods, path_regexp = nil, options = {})
       options = options.with_indifferent_access
-      route_set.append(methods, path_regexp, options.except(:request), proc { |request, match_data|
+      route_set.append(methods, path_regexp, options.except(:request)) do |request, match_data|
         forwarder.call request, {'match_data' => match_data}.merge(options[:request] || {}).with_indifferent_access
-      })
+      end
     end
 
     def forward_all(options = {})
@@ -44,7 +44,7 @@ module ApiValve
     end
 
     def deny(methods, path_regexp = nil, with: 'Error::Forbidden')
-      route_set.append(methods, path_regexp, {}, ->(*_args) { raise ApiValve.const_get(with) })
+      route_set.append(methods, path_regexp, {}) { raise ApiValve.const_get(with) }
     end
 
     protected

data/lib/api_valve/route_set.rb

@@ -32,54 +32,54 @@ module ApiValve
       [route, match_data]
     end
 
-    def delete(path = nil, options = {}, prok = nil)
-      push :delete, path, options, prok || Proc.new
+    def delete(path = nil, options = {}, &block)
+      push :delete, path, options, &block
     end
 
-    def get(path = nil, options = {}, prok = nil)
-      push :get, path, options, prok || Proc.new
+    def get(path = nil, options = {}, &block)
+      push :get, path, options, &block
     end
 
-    def head(path = nil, options = {}, prok = nil)
-      push :head, path, options, prok || Proc.new
+    def head(path = nil, options = {}, &block)
+      push :head, path, options, &block
     end
 
-    def patch(path = nil, options = {}, prok = nil)
-      push :patch, path, options, prok || Proc.new
+    def patch(path = nil, options = {}, &block)
+      push :patch, path, options, &block
     end
 
-    def post(path = nil, options = {}, prok = nil)
-      push :post, path, options, prok || Proc.new
+    def post(path = nil, options = {}, &block)
+      push :post, path, options, &block
     end
 
-    def put(path = nil, options = {}, prok = nil)
-      push :put, path, options, prok || Proc.new
+    def put(path = nil, options = {}, &block)
+      push :put, path, options, &block
     end
 
-    def any(path = nil, options = {}, prok = nil)
-      append METHODS, path, options, prok || Proc.new
+    def any(path = nil, options = {}, &block)
+      append METHODS, path, options, &block
     end
 
-    def push(methods, regexp, options = {}, prok = nil)
-      add_route :push, methods, regexp, options, prok || Proc.new
+    def push(methods, regexp, options = {}, &block)
+      add_route :push, methods, regexp, options, &block
     end
 
     alias append push
 
-    def unshift(methods, regexp = nil, options = {}, prok = nil)
-      add_route :unshift, methods, regexp, options, prok || Proc.new
+    def unshift(methods, regexp = nil, options = {}, &block)
+      add_route :unshift, methods, regexp, options, &block
     end
 
     def reset_routes
-      @routes = Hash[METHODS.map { |v| [v, []] }].with_indifferent_access.freeze
+      @routes = METHODS.to_h { |v| [v, []] }.with_indifferent_access.freeze
     end
 
     private
 
-    def add_route(how, methods, regexp, options, prok)
+    def add_route(how, methods, regexp, options, &block)
       methods = METHODS if methods.to_s == 'any'
       Array.wrap(methods).each do |method|
-        @routes[method].public_send how, Route.new(regexp, options, prok)
+        @routes[method].public_send how, Route.new(regexp, options, block)
       end
     end
   end

data/lib/api_valve.rb

@@ -1,3 +1,4 @@
+require 'active_support'
 require 'active_support/callbacks'
 require 'active_support/configurable'
 require 'active_support/core_ext/class'
@@ -5,6 +6,7 @@ require 'active_support/core_ext/hash'
 require 'active_support/core_ext/object'
 require 'active_support/core_ext/module'
 require 'active_support/json'
+require 'active_support/notifications'
 require 'active_support/rescuable'
 require 'benchmark'
 require 'faraday'
@@ -26,7 +28,7 @@ module ApiValve
   include ActiveSupport::Configurable
 
   config_accessor :logger do
-    Logger.new(STDOUT)
+    Logger.new($stdout)
   end
 
   config_accessor :error_responder do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_valve
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 1.0.1
 platform: ruby
 authors:
 - mkon
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-05 00:00:00.000000000 Z
+date: 2022-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -37,9 +37,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.14'
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -47,9 +47,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.14'
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -126,28 +126,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.82.0
+        version: 1.28.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.82.0
+        version: 1.28.2
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.39.0
+        version: 2.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.39.0
+        version: 2.10.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -190,7 +190,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
-description: 
+description:
 email:
 - konstantin@munteanu.de
 executables: []
@@ -220,8 +220,9 @@ files:
 homepage: https://github.com/mkon/api_valve
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -229,15 +230,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Lightweight ruby/rack API reverse proxy or gateway
 test_files: []