kiev 2.7.3

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+require "rake/testtask"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end
+
+require "rubocop/rake_task"
+desc "Run RuboCop"
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.options = ["--display-cop-names"]
+end
+
+task default: %w(spec test rubocop)

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require_relative "../lib/kiev"
+
+require "irb"
+IRB.start

data/config.ru

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler"
+
+Bundler.require :default, :development
+
+Combustion.initialize!(:all)
+run Combustion::Application

data/gemfiles/que_0.12.2.gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+gem "oj"
+
+# Build brakes with 0.12.3, TODO: handle this
+gem "que", "0.12.2"
+gem "pg"
+gem "sequel"
+
+gem "rack-test", require: false
+gem "rspec", require: false
+gem "minitest-reporters", require: false
+
+gemspec :path => "../"

data/gemfiles/que_0.12.3.gemfile

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+# need it because of bug in https://github.com/chanks/que/issues/191
+gem "multi_json"
+gem "oj"
+
+gem "que", ">= 0.12.3"
+gem "pg"
+gem "sequel"
+
+gem "rack-test", require: false
+gem "rspec", require: false
+gem "minitest-reporters", require: false
+
+gemspec :path => "../"

data/gemfiles/rails_4.1.gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+gem "oj"
+
+gem "rails", "4.1.16"
+gem "sqlite3"
+
+gem "combustion"
+gem "rspec", require: false
+gem "rspec-rails", require: false
+gem "minitest-reporters", require: false
+
+gemspec :path => "../"

data/gemfiles/rails_4.2.gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+gem "oj"
+
+gem "rails", "4.2.7"
+gem "sqlite3"
+
+gem "combustion"
+gem "rspec", require: false
+gem "rspec-rails", require: false
+gem "minitest-reporters", require: false
+
+gemspec :path => "../"

data/gemfiles/sidekiq_4.2.gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+gem "oj", "~> 2"
+
+gem "sidekiq", "~> 4.2.0"
+
+gem "rack-test", require: false
+gem "rspec", require: false
+gem "minitest-reporters", require: false
+
+gem "her"
+
+gemspec :path => "../"
+

data/gemfiles/sinatra_1.4.gemfile

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+gem "oj"
+
+gem "xml-simple"
+
+gem "sinatra", "1.4.7"
+gem "sinatra-contrib"
+gem "rack-parser", :require => "rack/parser"
+
+gem "rack-test", require: false
+gem "rspec", require: false
+gem "minitest-reporters", require: false
+
+gemspec :path => "../"

data/gemfiles/sinatra_2.0.gemfile

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+gem "oj"
+
+gem "xml-simple"
+
+gem "sinatra", "2.0.0"
+gem "sinatra-contrib"
+gem "rack-parser", :require => "rack/parser"
+
+gem "rack-test", require: false
+gem "rspec", require: false
+gem "minitest-reporters", require: false
+
+gemspec :path => "../"

data/kiev.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require File.join(File.dirname(__FILE__), "lib/kiev/version")
+
+Gem::Specification.new do |spec|
+  spec.name          = "kiev"
+  spec.version       = Kiev::VERSION
+  spec.authors       = ["Blacklane"]
+  spec.licenses      = ["MIT"]
+
+  spec.summary       = "Distributed logging to JSON integrated with various Ruby frameworks and tools"
+  spec.description   = "Kiev is a logging tool aimed at distributed environments. It logs to JSON, while providing human-readable output in development mode. It integrates nicely with Rails, Sinatra and other Rack-based frameworks, Sidekiq, Que, HTTParty, Her and other Faraday-based HTTP clients."
+  spec.homepage      = "https://github.com/blacklane/kiev"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.0.0"
+  spec.add_dependency "rack", ">= 1", "< 3"
+  spec.add_dependency "request_store", ">= 1.0", "< 1.4"
+  spec.add_dependency "oga", "~> 2.2"
+  spec.add_dependency "ruby_dig", "~> 0.0.2" # to support ruby 2.2
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop", "0.49.1"
+end

data/lib/ext/rack/common_logger.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Disable useless rack logger completely!
+# for some reason disable :logging doesn't work for sinatra
+module Rack
+  class CommonLogger
+    def call(env)
+      # do nothing
+      @app.call(env)
+    end
+  end
+end

data/lib/kiev.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "kiev/base"
+require_relative "kiev/rack" if defined?(Rack)
+require_relative "kiev/railtie" if defined?(Rails)
+require_relative "kiev/sidekiq" if defined?(Sidekiq)
+require_relative "kiev/her_ext/client_request_id" if defined?(Faraday)
+require_relative "kiev/httparty" if defined?(HTTParty)
+require_relative "kiev/que/job" if defined?(Que::Job)

data/lib/kiev/base.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "request_store"
+require "ruby_dig"
+require_relative "request_store"
+require_relative "logger"
+require_relative "param_filter"
+require_relative "request_body_filter"
+require_relative "json"
+require_relative "version"
+require_relative "config"
+require_relative "util"
+require_relative "subrequest_helper"
+
+module Kiev
+  class << self
+    EMPTY_OBJ = {}.freeze
+
+    def configure
+      yield(Config.instance)
+    end
+
+    def logger
+      Config.instance.logger
+    end
+
+    def event(event_name, data = EMPTY_OBJ)
+      logger.log(::Logger::Severity::INFO, data, event_name)
+    end
+
+    def []=(name, value)
+      RequestStore.store[:payload] ||= {}
+      RequestStore.store[:payload][name] = value
+    end
+
+    def payload(data)
+      raise ArgumentError, "Hash expected" unless data.is_a?(Hash)
+
+      RequestStore.store[:payload] ||= {}
+      RequestStore.store[:payload].merge!(data)
+    end
+
+    def error=(value)
+      RequestStore.store[:error] = value
+    end
+
+    def request_id
+      RequestStore.store[:request_id]
+    end
+  end
+end

data/lib/kiev/base52.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: false
+
+module Kiev
+  module Base52
+    KEYS = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz".freeze
+    BASE = KEYS.length.freeze
+
+    def self.encode(num)
+      return KEYS[0] if num == 0
+      return nil if num < 0
+
+      str = ""
+      while num > 0
+        str.prepend(KEYS[num % BASE])
+        num /= BASE
+      end
+      str
+    end
+  end
+end

data/lib/kiev/config.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+require "singleton"
+
+module Kiev
+  class Config
+    include Singleton
+
+    DEFAULT_LOG_REQUEST_REGEXP = %r{(^(/ping|/health))|(\.(js|css|png|jpg|gif|ico|svg)$)}
+    private_constant :DEFAULT_LOG_REQUEST_REGEXP
+
+    DEFAULT_LOG_REQUEST_CONDITION = proc do |request, _response|
+      !DEFAULT_LOG_REQUEST_REGEXP.match(request.path)
+    end
+
+    DEFAULT_LOG_REQUEST_ERROR_CONDITION = proc do |_request, response|
+      response.status != 404
+    end
+
+    DEFAULT_LOG_RESPONSE_BODY_REGEXP = /(json|xml)/
+    private_constant :DEFAULT_LOG_RESPONSE_BODY_REGEXP
+
+    DEFAULT_LOG_RESPONSE_BODY_CONDITION = proc do |_request, response|
+      !!(response.status >= 400 && response.status < 500 && response.content_type =~ DEFAULT_LOG_RESPONSE_BODY_REGEXP)
+    end
+
+    DEFAULT_LOG_REQUEST_BODY_CONDITION = proc do |request, _response|
+      !!(request.content_type =~ /(application|text)\/xml/)
+    end
+
+    DEFAULT_IGNORED_RACK_EXCEPTIONS =
+      %w(
+        ActiveRecord::RecordNotFound
+        Mongoid::Errors::DocumentNotFound
+        Sequel::RecordNotFound
+      ).freeze
+
+    FILTERED_PARAMS =
+      %w(
+        client_secret
+        token
+        password
+        password_confirmation
+        old_password
+        credit_card_number
+        credit_card_cvv
+        credit_card_holder
+        credit_card_expiry_month
+        credit_card_expiry_year
+        CardNumber
+        CardCVV
+        CardExpires
+      ).freeze
+
+    IGNORED_PARAMS =
+      (%w(
+        controller
+        action
+        format
+        authenticity_token
+        utf8
+        tempfile
+      ) << :tempfile).freeze
+
+    DEFAULT_HTTP_PROPAGATED_FIELDS = {
+      request_id: "X-Request-Id",
+      request_depth: "X-Request-Depth",
+      tree_path: "X-Tree-Path"
+    }.freeze
+
+    DEFAULT_PRE_RACK_HOOK = proc do |env|
+      Config.instance.http_propagated_fields.each do |key, http_key|
+        Kiev[key] = Util.sanitize(env[Util.to_http(http_key)])
+      end
+    end
+
+    attr_accessor :app,
+                  :log_request_condition,
+                  :log_request_error_condition,
+                  :log_response_body_condition,
+                  :log_request_body_condition,
+                  :filtered_params,
+                  :ignored_params,
+                  :ignored_rack_exceptions,
+                  :disable_default_logger,
+                  :persistent_log_fields,
+                  :pre_rack_hook
+
+    attr_reader :development_mode,
+                :logger,
+                :http_propagated_fields,
+                :jobs_propagated_fields,
+                :all_http_propagated_fields, # for internal use
+                :all_jobs_propagated_fields # for internal use
+
+    def initialize
+      @log_request_condition = DEFAULT_LOG_REQUEST_CONDITION
+      @log_request_error_condition = DEFAULT_LOG_REQUEST_ERROR_CONDITION
+      @log_response_body_condition = DEFAULT_LOG_RESPONSE_BODY_CONDITION
+      @log_request_body_condition = DEFAULT_LOG_REQUEST_BODY_CONDITION
+      @filtered_params = FILTERED_PARAMS
+      @ignored_params = IGNORED_PARAMS
+      @disable_default_logger = true
+      @development_mode = false
+      @ignored_rack_exceptions = DEFAULT_IGNORED_RACK_EXCEPTIONS.dup
+      @logger = Kiev::Logger.new(STDOUT)
+      @log_level = nil
+      @persistent_log_fields = []
+      @pre_rack_hook = DEFAULT_PRE_RACK_HOOK
+      self.propagated_fields = {}
+      update_logger_settings
+    end
+
+    def http_propagated_fields=(value)
+      @all_http_propagated_fields = DEFAULT_HTTP_PROPAGATED_FIELDS.merge(value)
+      @http_propagated_fields = @all_http_propagated_fields.dup
+      DEFAULT_HTTP_PROPAGATED_FIELDS.keys.each do |key|
+        @http_propagated_fields.delete(key)
+      end
+      @http_propagated_fields.freeze
+    end
+
+    def jobs_propagated_fields=(value)
+      @all_jobs_propagated_fields = (DEFAULT_HTTP_PROPAGATED_FIELDS.keys + value).uniq.freeze
+      @jobs_propagated_fields = (@all_jobs_propagated_fields - DEFAULT_HTTP_PROPAGATED_FIELDS.keys).freeze
+    end
+
+    # shortcut
+    def propagated_fields=(value)
+      self.http_propagated_fields = value
+      self.jobs_propagated_fields = value.keys
+    end
+
+    def log_path=(value)
+      logger.path = value
+      update_logger_settings
+    end
+
+    def log_level=(value)
+      @log_level = value
+      update_logger_settings
+    end
+
+    def development_mode=(value)
+      @development_mode = value
+      update_logger_settings
+    end
+
+    private
+
+    def update_logger_settings
+      @logger.formatter = formatter
+      @logger.level = @log_level || default_log_level
+    end
+
+    def formatter
+      development_mode ? Logger::DEVELOPMENT_FORMATTER : Logger::FORMATTER
+    end
+
+    def default_log_level
+      development_mode ? ::Logger::DEBUG : ::Logger::INFO
+    end
+  end
+end

data/lib/kiev/her_ext/client_request_id.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "../base"
+
+module Kiev
+  module HerExt
+    class ClientRequestId < Faraday::Middleware
+      def call(env)
+        env[:request_headers].merge!(SubrequestHelper.headers)
+        @app.call(env)
+      end
+    end
+  end
+end