rest-client-jogger 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 254a3539166588b4e3714b707f3fc9fe3863eab4
-  data.tar.gz: 98b917ea8c0f63746d9355332b7c60a9d3e75007
+SHA256:
+  metadata.gz: 9a0a62a17950b37627e424ef0c17fc446f51689aae27a1818d28c16f74b3852e
+  data.tar.gz: 052a357239835355293654cad1823ba3986b2419169381d8e4e456fd47523967
 SHA512:
-  metadata.gz: 1865224976e1177abfde1289937bc1ee0fe55d70978c7952425df09aedfefd2c0d36ef2e858d8049fb3ee0c97734d0fbc41d65929cdddb21ee123eb3fa2d76ff
-  data.tar.gz: af9bfd166bc96f7dc5fd03a58c38503d6859f2662e5ce9897f39a644a87e74b00348b9f43aefc7f04ba5e2f753c1ba470084b6d824ae285b338b4073ed15b88c
+  metadata.gz: 3549ff1e7d43c69b90e8b5b275274aab4e012260a28b77494f9dcb4ec34a13bf64aa7ba78a3e414ac262f17875fbc5acc18fd90d099626c3a987dd0940096e2e
+  data.tar.gz: 410ac3b52d87e846006061114c0f78a6e18a03d25998420cc0d80c9c0b007809f242b415ed8a787ebfa452b836c9d4767645463da6dc8685339bd73b378444d3

data/.rspec

@@ -1,3 +1,2 @@
---require spec_helper
---format documentation
 --color
+--require spec_helper

data/.travis.yml

@@ -1,11 +1,13 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.1.2
   - 2.2.0
   - 2.2.1
   - 2.2.2
   - 2.2.3
   - 2.3.0
   - 2.5.1
-before_install: gem install bundler -v 1.12.3
+  - 2.6.3
+before_install: gem install bundler -v '1.17.3'
+install: bundle _1.17.3_ install
+script: bundle _1.17.3_ exec rake

data/lib/rest_client/core_ext/logged_request.rb

@@ -30,7 +30,8 @@ module LoggedRequest
   end
 
   def filtered_headers(opts)
-    opts.fetch(:headers, {}).reject { |k, _| k.to_s.casecmp('authorization').zero? }
+    headers = opts.fetch(:headers) { {} }
+    RestClient::Jogger::Filters::Headers.new(data: headers).filter
   end
 
   def log_request(opts, started)

data/lib/rest_client/jogger.rb

@@ -1,4 +1,6 @@
+require 'cgi'
 require 'json'
+require 'uri'
 require 'mime/types'
 require 'active_model'
 require 'active_support/all'
@@ -11,16 +13,19 @@ require 'rest_client/jogger/action'
 require 'rest_client/jogger/request'
 require 'rest_client/jogger/response'
 require 'rest_client/jogger/filters/base'
+require 'rest_client/jogger/filters/headers'
 require 'rest_client/jogger/filters/json'
 require 'rest_client/jogger/filters/xml'
+require 'rest_client/jogger/filters/query_parameters'
 require 'rest_client/core_ext/logged_request'
 
 module RestClient
   class Request
     extend LoggedRequest
   end
-  
+
   module Jogger
+    AGENT_VERSION = "rest-client-jogger:#{VERSION}".freeze
     ROOT_PATH = File.expand_path(File.dirname(__FILE__)).freeze
 
     class << self

data/lib/rest_client/jogger/action.rb

@@ -14,19 +14,8 @@ module RestClient
       end
 
       def call(name, start, finish, id, payload)
-        start_time = payload.fetch(:start_time)
-        render_params = {
-          args: payload,
-          payload: filter(payload),
-          verify_ssl: payload[:verify_ssl],
-          read_timeout: payload.fetch(:timeout) { payload[:read_timeout] },
-          open_timeout: payload.fetch(:timeout) { payload[:open_timeout] },
-          event_id: id,
-          timestamp: start,
-          time_elapsed: (finish - start_time).round(10),
-          ip_address: ip_address
-        }
-        json = template.render nil, render_params
+        params = render_params(start, finish, id, payload)
+        json = template.render(nil, params)
         name =~ /error/ ? logger.error(json) : logger.debug(json)
       rescue StandardError => e
         notifier.error e, payload: payload
@@ -38,8 +27,27 @@ module RestClient
 
       private
 
+      def render_params(start, finish, id, opts)
+        start_time = opts.fetch(:start_time)
+        url = opts.fetch(:url)
+        headers = opts.fetch(:headers) { {} }
+        {
+          method: opts[:method],
+          headers: headers,
+          url: RestClient::Jogger::Filters::QueryParameters.new(data: url).filter,
+          payload: filter(body: opts[:payload], headers: headers),
+          verify_ssl: opts[:verify_ssl],
+          read_timeout: opts.fetch(:timeout) { opts[:read_timeout] },
+          open_timeout: opts.fetch(:timeout) { opts[:open_timeout] },
+          event_id: id,
+          timestamp: start,
+          time_elapsed: (finish - start_time).round(10),
+          ip_address: ip_address
+        }
+      end
+
       def filter(opts = {})
-        filter_class(opts[:headers] || {}).new(data: opts[:payload].to_s).filter
+        filter_class(opts.fetch(:headers)).new(data: opts[:body].to_s).filter
       end
 
       def filter_class(headers = {})

data/lib/rest_client/jogger/filters/base.rb

@@ -43,7 +43,7 @@ module RestClient
           @content_type ||= RestClient::Jogger.default_content_type
         end
 
-      private
+        private
 
         def filter_parameters
           defined?(Rails) ? Rails.configuration.filter_parameters : RestClient::Jogger.filter_parameters

data/lib/rest_client/jogger/filters/headers.rb

@@ -0,0 +1,32 @@
+module RestClient
+  module Jogger
+    module Filters
+      class Headers < Base
+        DEFAULT_FILTERS = %w[authorization].freeze
+
+        def filter
+          filtered_keys = string_filters
+          data.each_with_object({}) do |(key, value), memo|
+            if filtered_keys.include?(key.to_s.downcase)
+              memo[key] = filter_replacement
+            else
+              memo[key] = value
+            end
+          end
+        end
+
+        private
+
+        def string_filters
+          DEFAULT_FILTERS | normalized_filters
+        end
+
+        def normalized_filters
+          filters
+            .select { |e| e.is_a?(Symbol) || e.is_a?(String) }
+            .map { |e| e.to_s.downcase }
+        end
+      end
+    end
+  end
+end

data/lib/rest_client/jogger/filters/json.rb

@@ -1,9 +1,9 @@
 module RestClient
   module Jogger
     module Filters
-      class Json < RestClient::Jogger::Filters::Base
+      class Json < Base
 
-      private
+        private
 
         def filter_data(filter)
           data.gsub! /"#{filter}":\s*"[^"]*"/, %{"#{filter}": "#{filter_replacement}"}

data/lib/rest_client/jogger/filters/query_parameters.rb

@@ -0,0 +1,30 @@
+module RestClient
+  module Jogger
+    module Filters
+      class QueryParameters < Base
+        def filter
+          return uri.to_s if uri.query.blank?
+          uri.dup.tap { |u| u.query = parameters }.to_s
+        end
+
+        private
+
+        def parameters
+          CGI.parse(uri.query.to_s).each_with_object([]) do |(key, values), memo|
+            values.each do |value|
+              memo << "#{key}=#{filtered_value(key, value)}"
+            end
+          end.join('&')
+        end
+
+        def filtered_value(key, value)
+          filters.include?(key.to_sym) ? filter_replacement : value
+        end
+
+        def uri
+          @uri ||= URI.parse(data)
+        end
+      end
+    end
+  end
+end

data/lib/rest_client/jogger/filters/xml.rb

@@ -1,9 +1,9 @@
 module RestClient
   module Jogger
     module Filters
-      class Xml < RestClient::Jogger::Filters::Base
+      class Xml < Base
 
-      private
+        private
 
         def filter_data(filter)
           data.gsub! /<#{filter}>(.*)<\/#{filter}>/, %{<#{filter}>#{filter_replacement}</#{filter}>}

data/lib/rest_client/jogger/response.rb

@@ -2,7 +2,29 @@ module RestClient
   module Jogger
     class Response < Action
       def template
-        Tilt::JbuilderTemplate.new root.join('templates', 'response_logging_template.json.jbuilder')
+        Tilt::JbuilderTemplate.new(root.join('templates', 'response_logging_template.json.jbuilder'))
+      end
+
+      private
+
+      def render_params(start, finish, id, opts)
+        params = response_params(opts)
+        super.merge(params)
+      end
+
+      def response_params(opts = {})
+        response_headers = opts[:response].try(:headers) || {}
+        response_body = opts[:response].try(:body).to_s.force_encoding('UTF-8')
+        {
+          exception: opts[:exception],
+          response_headers: filtered_headers(response_headers),
+          response_body: filter(body: response_body, headers: response_headers),
+          code: opts[:response].try(:code)
+        }
+      end
+
+      def filtered_headers(headers = {})
+        Filters::Headers.new(data: headers).filter
       end
     end
   end

data/lib/rest_client/jogger/version.rb

@@ -1,5 +1,5 @@
 module RestClient
   module Jogger
-    VERSION = '1.1.0'.freeze
+    VERSION = '1.2.0'.freeze
   end
 end

data/lib/rest_client/templates/request_logging_template.json.jbuilder

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 json.ignore_nil!
-json.url args[:url]
-json.method args[:method]
+json.url url
+json.method method
 json.verifySsl verify_ssl
-json.requestHeaders args.fetch(:headers, {})
+json.requestHeaders headers
 json.requestBody payload
 json.sourceIp ip_address
 json.eventName RestClient::Jogger.request_pattern
 json.eventId event_id
+json.eventAgent RestClient::Jogger::AGENT_VERSION
 json.timeElapsed time_elapsed
 json.openTimeout open_timeout
 json.readTimeout read_timeout

data/lib/rest_client/templates/response_logging_template.json.jbuilder

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
 json.ignore_nil!
-json.exception args[:exception]
-json.url args[:url]
-json.method args[:method]
+json.url url
+json.exception exception
+json.method method
 json.verifySsl verify_ssl
-json.requestHeaders args.fetch(:headers, {})
-json.responseHeaders args[:response].try(:headers)
+json.requestHeaders headers
+json.responseHeaders response_headers
 json.requestBody payload
-json.responseBody args[:response].try(:body).to_s.force_encoding('UTF-8')
+json.responseBody response_body
 json.sourceIp ip_address
 json.eventName RestClient::Jogger.response_pattern
 json.eventId event_id
+json.eventAgent RestClient::Jogger::AGENT_VERSION
 json.timeElapsed time_elapsed
 json.openTimeout open_timeout
 json.readTimeout read_timeout
-json.code args[:response].try(:code)
+json.code code
 json.timestamp timestamp.iso8601

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rest-client-jogger
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Jordan Babe
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-04 00:00:00.000000000 Z
+date: 2019-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -263,7 +263,9 @@ files:
 - lib/rest_client/jogger/configuration.rb
 - lib/rest_client/jogger/event_subscriber.rb
 - lib/rest_client/jogger/filters/base.rb
+- lib/rest_client/jogger/filters/headers.rb
 - lib/rest_client/jogger/filters/json.rb
+- lib/rest_client/jogger/filters/query_parameters.rb
 - lib/rest_client/jogger/filters/xml.rb
 - lib/rest_client/jogger/request.rb
 - lib/rest_client/jogger/response.rb
@@ -291,7 +293,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Logs RestClient requests in a JSON format