api_valve 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd0650e0cecef4ec781e6e8a4386ad05573de8b79174d624c7b08af1dfef02bf
-  data.tar.gz: a608b1470fdfa950fb23edf5bd05949cff1a3ebf1a89a100994c1f3119999213
+  metadata.gz: 4c5ecd7703186bfbcd52c8b50d3a643a5c2af56043e92f00e56b8b1863c38fb7
+  data.tar.gz: 95263987cdf177ce4703955572e28f4540a3c32f47fb7b519fd0233b79506160
 SHA512:
-  metadata.gz: 62804cac7016ef7ec069e17ccc229fe25356de1702512de74b425de0a07331464a9067750d0243aa618cdab1100fcc96e05a5095c969e289c567d66adc8d914d
-  data.tar.gz: e36dc22f1603317981cf07e372b0deb1a6c65b3ae18b15894a287adb78c7a682e3c90385566e455b7be1dc44d70d8117b6327b31b592d207b7dbc1b3dbd80130
+  metadata.gz: a43f1ff0ea8e795a1676bd918b9d849d2404a14793f6ccf93adac8b70c3aa672729822a1e6d516f38201ae3505023e3d0adc46c0a4257497c6c5aaa577bc97fe
+  data.tar.gz: 2db871a83ee2dc02b2639ba0e6c19a795f765e24421ef0aacc8ec2f4adbefd2b682d7746cb8c99cd0e976d5afe89af70abb87cb2680dbce92c9f45d6458ed467

data/README.md

@@ -1,6 +1,6 @@
 # ApiValve
 
-Lightweight API reverse proxy written in ruby. Based on rack.
+Extensible rack application that serves as lightweight API reverse proxy.
 
 ## Installation
 
@@ -10,5 +10,5 @@ Just add the gem
 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.
+See the [examples](https://github.com/mkon/api_valve/tree/master/examples) section on how to
+create & configure your own proxy using this gem.

data/lib/api_valve/forwarder/request.rb

@@ -12,12 +12,7 @@ module ApiValve
     WHITELISTED_HEADERS = %w(
       Accept
       Content-Type
-      Forwarded
       User-Agent
-      X-Forwarded-For
-      X-Forwarded-Host
-      X-Forwarded-Port
-      X-Forwarded-Proto
       X-Real-IP
     ).freeze
     NOT_PREFIXED_HEADERS = %w(
@@ -58,7 +53,9 @@ module ApiValve
     def headers
       whitelisted_headers.each_with_object({}) do |key, h|
         h[key] = header(key)
-      end.merge('X-Request-Id' => Thread.current[:request_id]).compact
+      end.merge(forwarded_headers).merge(
+        'X-Request-Id' => Thread.current[:request_id]
+      ).compact
     end
 
     # Returns body to forward to the target endpoint
@@ -77,6 +74,21 @@ module ApiValve
 
     private
 
+    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
+      }
+    end
+
+    def x_forwarded_for
+      (
+        header('X-Forwarded-For').to_s.split(', ') << original_request.env['REMOTE_ADDR']
+      ).join(', ')
+    end
+
     def header(name)
       name = "HTTP_#{name}" unless NOT_PREFIXED_HEADERS.include? name
       name = name.upcase.tr('-', '_')

data/lib/api_valve/forwarder/response.rb

@@ -39,7 +39,11 @@ module ApiValve
 
     def headers
       whitelisted_headers.each_with_object({}) do |k, h|
-        h[k] = original_response.headers[k]
+        if k == 'Location'
+          h[k] = adjust_location(original_response.headers[k])
+        else
+          h[k] = original_response.headers[k]
+        end
       end.compact
     end
 
@@ -47,6 +51,11 @@ module ApiValve
       @options[:whitelisted_headers] || WHITELISTED_HEADERS
     end
 
+    def adjust_location(location)
+      return location if @options[:target_prefix] == @options[:local_prefix]
+      location&.gsub(/^#{@options[:target_prefix]}/, @options[:local_prefix])
+    end
+
     def body
       original_response.body.to_s
     end

data/lib/api_valve/forwarder.rb

@@ -15,6 +15,8 @@ module ApiValve
     # response: Options for the response wrapper. See Response#new
     def initialize(options = {})
       @options = options.with_indifferent_access
+      uri = URI(options[:endpoint])
+      @target_prefix = uri.path
     end
 
     # Takes the original rack request with optional options and returns a rack response
@@ -23,7 +25,14 @@ module ApiValve
     def call(original_request, local_options = {})
       request = request_klass.new(original_request, request_options.deep_merge(local_options))
       raise Error::Forbidden unless request.allowed?
-      response_klass.new(original_request, run_request(request), response_options).rack_response
+      response_klass.new(
+        original_request,
+        run_request(request),
+        response_options.merge(
+          target_prefix: @target_prefix,
+          local_prefix: original_request.env['SCRIPT_NAME']
+        )
+      ).rack_response
     end
 
     private
@@ -43,7 +52,8 @@ module ApiValve
 
     def response_options
       # integrate permission handler options as it is instantiated in the response
-      (@options[:response] || {}).merge(@options.slice(:permission_handler) || {})
+      (@options[:response] || {})
+        .merge(@options.slice(:permission_handler) || {})
     end
 
     def run_request(request)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_valve
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - mkon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-04 00:00:00.000000000 Z
+date: 2018-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport