api_valve 0.7.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8fa553cf63a283fd6e72a46cb30c19163ce549d22f4bff7dbb9655410e4e7e7
-  data.tar.gz: 745c509254b829d2ce45379b7af4ec142c5e9b5e9cc9e5f8ab07cd97a8266433
+  metadata.gz: a0e6669812fb7067607a8013b6080931d548f23df184bfd4f7a722d0a2ead98d
+  data.tar.gz: 241d1a7a8cac8aa6795418e3dbb54b016262eb476f3cfba5fdfece748ab204da
 SHA512:
-  metadata.gz: 012b93b4f857f380704560f4054ae14f83268487b4459736cad43d68298835719f196ac2aa1cae2b16c3f2210cfb5dc6220e6a4f9bd878dadf5449a24db779b8
-  data.tar.gz: fd1800285717f50a2754caf05cb7f3cb777eefb49ec9262674dbce968e670e099bf5f83d662ebd0b9120405f20b3585522d56a2674f21f0afe37a44bf661d60e
+  metadata.gz: 44e8eba0a335b9740b37cc189f3418358c42bb99245a614b6acf042201096fced3f3eb306814ccb2c628566cf80b78676339f4db47a4a7490476275f746c2013
+  data.tar.gz: d1d4909884073aafce0cbbd9d091d3613c84422d90db4911c4f6bb540c62eba6b80fb6a3a1a5365dedf9166e24db17b4721a8e31ddd9e81e0a516f58e5016df2

data/README.md

@@ -1,7 +1,7 @@
 # ApiValve
 
 [![Gem Version](https://badge.fury.io/rb/api_valve.svg)](https://badge.fury.io/rb/api_valve)
-[![Build Status](https://travis-ci.org/mkon/api_valve.svg?branch=master)](https://travis-ci.org/mkon/api_valve)
+![](https://github.com/mkon/api_valve/workflows/Test/badge.svg?branch=master)
 [![Depfu](https://badges.depfu.com/badges/1f5892cc85d02997050e0a4d077c7dc4/overview.svg)](https://depfu.com/github/mkon/api_valve?project_id=5958)
 
 Extensible rack application that serves as lightweight API reverse proxy.
@@ -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.rb

@@ -5,6 +5,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 +27,7 @@ module ApiValve
   include ActiveSupport::Configurable
 
   config_accessor :logger do
-    Logger.new(STDOUT)
+    Logger.new($stdout)
   end
 
   config_accessor :error_responder do

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.rb

@@ -69,7 +69,7 @@ module ApiValve
     end
 
     def log_request(request)
-      ApiValve.logger.info do
+      ApiValve.logger.debug do
         format(
           '-> %<method>s %<endpoint>s%<path>s',
           method:   request.method.upcase,
@@ -80,7 +80,7 @@ module ApiValve
     end
 
     def log_response(response, elapsed_time)
-      ApiValve.logger.info do
+      ApiValve.logger.debug do
         format(
           '<- %<status>s in %<ms>dms',
           status: response.status,
@@ -94,6 +94,7 @@ module ApiValve
         url: endpoint,
         ssl: {verify: false}
       ) do |config|
+        config.request :instrumentation
         config.adapter Faraday.default_adapter
       end
     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/middleware/permission_check.rb

@@ -11,7 +11,7 @@ class ApiValve::Middleware
         @app.call(env)
       else
         message = handler(env).message
-        ApiValve.logger.info { message }
+        ApiValve.logger.debug { message }
         render_error ApiValve::Error::Forbidden.new message
       end
     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/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/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.map { |v| [v, []] }.to_h.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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_valve
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 1.0.0
 platform: ruby
 authors:
 - mkon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-25 00:00:00.000000000 Z
+date: 2021-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,34 +16,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.2
+        version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.2
+        version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -120,28 +126,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 1.18.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 1.18.2
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.33.0
+        version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.33.0
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -223,14 +229,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
+  - - "<"
+    - !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.4
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Lightweight ruby/rack API reverse proxy or gateway