api_valve 0.0.1.beta.1 → 0.0.1.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0db44e3a1e246e94e9c31ad856fef01d7b76626cfe665bd18dfa769223c385bc
-  data.tar.gz: 7a05b9b44d9606bb831da1709bacc50135115311d4517f87bdad59e17ea3340d
+  metadata.gz: 88db069feae42e9dc2fe3397891acfc31567a36b057a78c57d0a8ed2be567be7
+  data.tar.gz: 29aba6e067ae80f88effcde5d03d048eff6137c34b11376ae0dfba9a0b47669b
 SHA512:
-  metadata.gz: d86f709762d7cd80fe4d1d01184310ae422e38dac84c9244a968ce52cae0ede75365975d8bd86b3fc9bdc5e9dd16d34ac1e94bf3f6129d97d662cabb13ac72d8
-  data.tar.gz: a733954d49421ad1735f12c27b3361026c8a3f4d5378837090d5373dcfb75e8409adca6566b6d437cfb64d0512a8531b8de551a14cd65ed1c60771df4514e039
+  metadata.gz: 9c7d05c3e3788a426844ea4628c2fc8fa83def60bfba39e85f0138407c820ba81b942e947e3576e85d1fb27c62206698b6b60b517fdb08478cbeb202f541ab6f
+  data.tar.gz: 3c57ae3efe82c65ff552084300bc7b0aa494789490ed132689f0c48c91a4b0920c937767dd41564ad7e782578bdb92c567ae71e4a231de296dde1756261a7f75

data/lib/api_valve/error_responder.rb

@@ -39,7 +39,7 @@ module ApiValve
 
     def json_meta
       (@error.try(:to_hash).presence || {}).merge(
-        backtrace: ApiValve.expose_backtraces ? json_backtrace : nil
+        backtrace: ApiValve.expose_backtraces ? @error.backtrace : nil
       ).compact.presence
     end
   end

data/lib/api_valve/forwarder/request.rb

@@ -18,6 +18,7 @@ module ApiValve
       X-Forwarded-Host
       X-Forwarded-Port
       X-Forwarded-Proto
+      X-Real-IP
     ).freeze
     NOT_PREFIXED_HEADERS = %w(
       Content-Length

data/lib/api_valve/logger.rb

@@ -0,0 +1,21 @@
+require 'active_support/tagged_logging'
+require 'logger'
+
+module ApiValve
+  class Logger < ::Logger
+    include ActiveSupport::TaggedLogging
+
+    class Formatter < ActiveSupport::Logger::SimpleFormatter
+      include ActiveSupport::TaggedLogging::Formatter
+    end
+
+    def initialize(target = STDOUT)
+      super(target)
+      self.formatter = Formatter.new
+    end
+
+    # some rack apps have weird ways to write to rack.logger
+    alias puts error
+    alias write info
+  end
+end

data/lib/api_valve/middleware/logging.rb

@@ -0,0 +1,127 @@
+module ApiValve::Middleware
+  class Logging
+    include ActiveSupport::Configurable
+
+    class Log
+      INCOMING = %(Started %s "%s" for %s at %s).freeze
+      COMPLETE = %(Completed %s %s in %dms\n).freeze
+      URL_PARAMS = %(URL params %s).freeze
+      REQUEST_PAYLOAD = %(Request payload\n%s).freeze
+      REQUEST_HEADERS = %(Request HTTP Headers %s).freeze
+      RESPONSE_HEADERS = %(Response HTTP headers %s).freeze
+      RESPONSE_PAYLOAD = %(Response payload\n%s).freeze
+      NON_STANDARD_REQUEST_HEADERS = %w(CONTENT_LENGTH CONTENT_TYPE).freeze
+
+      attr_accessor :began_at, :env, :status, :response_headers, :response_payload
+
+      def initialize(options = {})
+        assign options
+      end
+
+      def assign(options = {})
+        options.each do |k, v|
+          public_send "#{k}=", v
+        end
+      end
+
+      def before_request
+        log_request
+        log_url_params
+        log_request_headers if Logging.log_request_headers
+        log_request_payload if Logging.log_request_payload
+      end
+
+      def after_request
+        log_response_headers if Logging.log_response_headers
+        log_response_payload if Logging.log_response_payload
+        log_response
+      end
+
+      private
+
+      delegate :logger, to: ApiValve
+
+      def log_request
+        logger.info INCOMING % [
+          env['REQUEST_METHOD'],
+          [env['PATH_INFO'], env['QUERY_STRING'].presence].compact.join('?'),
+          (env['HTTP_X_FORWARDED_FOR'] || env['REMOTE_ADDR']),
+          began_at.strftime('%Y-%m-%d %H:%M:%S %z')
+        ]
+      end
+
+      def log_url_params
+        return unless env['QUERY_STRING'].present?
+        logger.info URL_PARAMS % Rack::Utils.parse_nested_query(env['QUERY_STRING']).inspect
+      end
+
+      def log_request_headers
+        headers = {}
+        env.each_pair do |k, v|
+          next unless k =~ /^HTTP_/ && v.present?
+          next if v.blank? || (!k.start_with?('HTTP_') && !NON_STANDARD_REQUEST_HEADERS.include?(k))
+          headers[k] = v
+        end
+        return if headers.empty?
+        logger.debug REQUEST_HEADERS % headers
+      end
+
+      def log_request_payload
+        return unless %w(PATCH POST PUT).include? env['REQUEST_METHOD']
+        logger.debug REQUEST_PAYLOAD % env['rack.input'].read(1000)
+        env['rack.input'].rewind
+      end
+
+      def log_response_headers
+        return if response_headers&.empty?
+        logger.debug RESPONSE_HEADERS % response_headers.inspect
+      end
+
+      def log_response_payload
+        return if response_payload&.empty?
+        logger.debug RESPONSE_PAYLOAD % response_payload.first(config_log_body_size)
+      end
+
+      def log_response
+        logger.info COMPLETE % [
+          status,
+          Rack::Utils::HTTP_STATUS_CODES[status],
+          (Time.now - began_at) * 1000
+        ]
+      end
+    end
+
+    config_accessor :log_request_headers do
+      false
+    end
+
+    config_accessor :log_request_payload do
+      false
+    end
+
+    config_accessor :log_response_headers do
+      false
+    end
+
+    config_accessor :log_response_payload do
+      false
+    end
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      env['rack.logger'] = ApiValve.logger
+      env['rack.errors'] = ApiValve.logger
+      ApiValve.logger.tagged(Thread.current[:request_id]) do
+        log = Log.new(began_at: Time.now, env: env)
+        log.before_request
+        status, headers, body = @app.call(env)
+        log.assign status: status, response_headers: headers, response_payload: body
+        log.after_request
+        [status, headers, body]
+      end
+    end
+  end
+end

data/lib/api_valve/proxy.rb

@@ -9,8 +9,8 @@ module ApiValve
     define_callbacks :call
 
     class << self
-      def from_yaml(file_path)
-        from_hash YAML.load_file(file_path)
+      def from_yaml(string)
+        from_hash YAML.load(string) # rubocop:disable Security/YAMLLoad
       end
 
       def from_hash(config)

data/lib/api_valve.rb

@@ -16,6 +16,7 @@ module ApiValve
   autoload :Error,          'api_valve/error'
   autoload :ErrorResponder, 'api_valve/error_responder'
   autoload :Forwarder,      'api_valve/forwarder'
+  autoload :Logger,         'api_valve/logger'
   autoload :Proxy,          'api_valve/proxy'
   autoload :Router,         'api_valve/router'
 
@@ -23,6 +24,7 @@ module ApiValve
 
   module Middleware
     autoload :ErrorHandling, 'api_valve/middleware/error_handling'
+    autoload :Logging,       'api_valve/middleware/logging'
   end
 
   config_accessor :logger do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_valve
 version: !ruby/object:Gem::Version
-  version: 0.0.1.beta.1
+  version: 0.0.1.beta.2
 platform: ruby
 authors:
 - mkon
@@ -48,16 +48,16 @@ dependencies:
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -186,7 +186,9 @@ files:
 - lib/api_valve/forwarder/permission_handler.rb
 - lib/api_valve/forwarder/request.rb
 - lib/api_valve/forwarder/response.rb
+- lib/api_valve/logger.rb
 - lib/api_valve/middleware/error_handling.rb
+- lib/api_valve/middleware/logging.rb
 - lib/api_valve/proxy.rb
 - lib/api_valve/router.rb
 homepage: https://github.com/mkon/api_valve