rest-client-jogger 1.0.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 581926693bcbbc9ff8005be026b530a8b42cded9
-  data.tar.gz: 2ee7209470966596bdcbbcc8b8e16551ebb9f49c
+SHA256:
+  metadata.gz: 47ca02af5a3db97a2fe9f198002fdaca8e8df2bda98cd8bcd1f084b70518fbf3
+  data.tar.gz: 3707a76bcc37703ff62aaf87f26886323015db8331246dff7fc75e924c871e63
 SHA512:
-  metadata.gz: 8d58029a641c7195511401b82a2ab34865a23ef30d3cc744d89ab6e14ca64d42253807d8e40c59368a9cd193ef42b1f1958d3ef114b1aa2506738b9e51b101ab
-  data.tar.gz: d158f8c8abfd99e4cba22f18f66923bf6b8d0f3080ee963615f5cdc40bb1c719d5ccbb487a4bf99d2effad01837f311d4c23785cc0e18deec56b592fc2b34e40
+  metadata.gz: 1416bc0d1542f4d5b3ec43a22653f6904b22712004dc30b63d18d043c5f3f080711be75dfc2179a9474c025154af3809e2e4a28fafda2b721b19c4c38c5c60b1
+  data.tar.gz: f906820f356edc342087acba2f640bfcf27da162979b3abfe4104aea3310192f175f5a3038bbed3750d69f955a171aa0df308ead12f17727c27dbd9066c49f2f

data/.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - '2.5'
+          - '2.6'
+          - '2.7'
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Build and test with Rake
+        run: |
+          gem install bundler
+          echo 'bundle install'
+          bundle install --jobs 4 --retry 3
+          bundle exec rake

data/.rspec

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

data/README.md

@@ -46,6 +46,8 @@ RestClient::Jogger.configure do |config|
   config.response_pattern = 'my.response'          # optional
   config.default_content_type = 'application/json' # optional
   config.default_filter_replacement = '[SECRET]'   # optional
+  config.log_output = STDOUT                       # optional
+  config.filter_parameters = [:param_name]         # optional
 end
 ```
 

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,12 +27,32 @@ 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 = {})
-        content_type = headers.fetch(:content_type) { 'application/json' }
+        normalized_headers = headers.transform_keys { |k| k.to_s.downcase.tr('-', '_') }
+        content_type = normalized_headers.fetch('content_type') { 'application/json' }
         RestClient::Jogger::Filters::Base.filter_class(content_type)
       end
 

data/lib/rest_client/jogger/configuration.rb

@@ -9,6 +9,8 @@ module RestClient
         response_pattern
         default_content_type
         default_filter_replacement
+        log_output
+        filter_parameters
       ).freeze
       ATTRIBUTES = (REQUIRED_ATTRIBUTES | OPTIONAL_ATTRIBUTES).freeze
 
@@ -29,6 +31,14 @@ module RestClient
       def default_filter_replacement
         @default_filter_replacement || '[FILTERED]'
       end
+
+      def log_output
+        @log_output || 'log/rest_client.log'
+      end
+
+      def filter_parameters
+        @filter_parameters || []
+      end
     end
   end
 end

data/lib/rest_client/jogger/event_subscriber.rb

@@ -4,7 +4,7 @@ module RestClient
       attr_accessor :logger
 
       def logger
-        @logger ||= ActiveSupport::Logger.new('log/rest_client.log').tap { |l| l.level = Logger::DEBUG }
+        @logger ||= ActiveSupport::Logger.new(RestClient::Jogger.log_output).tap { |l| l.level = Logger::DEBUG }
       end
 
       def request_pattern

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

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

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.dup.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,7 @@
+# frozen_string_literal: true
+
 module RestClient
   module Jogger
-    VERSION = '1.0.1'.freeze
+    VERSION = '1.3.0'
   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

data/rest-client-jogger.gemspec

@@ -34,8 +34,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'tilt'
   spec.add_dependency 'tilt-jbuilder'
 
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 12.2"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-json_expectations"
   spec.add_development_dependency "rest-client", "~> 2.0.0"

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rest-client-jogger
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Jordan Babe
 - Jesse Doyle
 - Michael van den Beuken
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-10-09 00:00:00.000000000 Z
+date: 2021-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -114,30 +114,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -245,10 +245,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".simplecov"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -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
@@ -275,7 +277,7 @@ homepage: https://github.com/amaabca/rest-client-jogger
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -290,9 +292,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Logs RestClient requests in a JSON format
 test_files: []

data/.travis.yml

@@ -1,11 +0,0 @@
-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