rest-client-jogger 0.3.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ecd6f48719589c8f47c7e92403107cd44aa6d72c
-  data.tar.gz: d64c118b0c6e7c9d895e8c5702435170636a78d9
+  metadata.gz: 1b29dc3193cd558f466136f495d7ea42a94d0953
+  data.tar.gz: 43728ec66a9b0793099dd2bbd62929be94f9f477
 SHA512:
-  metadata.gz: dca84f7028099bfaa5e29752a823aaeda30918fe2ac9c702a8e5cd7f626e53178c57f5e2b6900c00a0d42715099a0e29c5bccf5fc342e193cac36057b24de351
-  data.tar.gz: 985b32ef827f83d61f779e7bf08c20238c7074ede4ad10f15a75fdec44059add01c3878a8e6bccdd626577beeb29bf6916bf2c960699a7bf9a7d8a0385070a21
+  metadata.gz: 91ebfb31dd64d8a640cc74411d5b80034ab923b21bc5de164df4c0d75a9c3556f4dc241b8b1c115e3eb1171b9fde1226acff6cf016bdd58b9e92ec8ccc7ea357
+  data.tar.gz: 3058eb900be88211bd950a75bf91fec49bd22af6cf3fa815a370601fc90293f0a633191e765149e84fa4228d31e9d94955dfa658129396d98a732bf1c317a1ff

data/.travis.yml

@@ -7,4 +7,5 @@ rvm:
   - 2.2.2
   - 2.2.3
   - 2.3.0
+  - 2.5.1
 before_install: gem install bundler -v 1.12.3

data/README.md

@@ -35,6 +35,20 @@ RestClient::Jogger::EventSubscriber.new.subscribe
 
 This will log all requests made with the `logged_request` method to a logfile in `log/rest_client.log`.
 
+## Configuration
+
+Some of the parameters used in this gem can be configured in the host application:
+
+```ruby
+# in an initializer somewhere
+RestClient::Jogger.configure do |config|
+  config.request_pattern = 'my.request'            # optional
+  config.response_pattern = 'my.response'          # optional
+  config.default_content_type = 'application/json' # optional
+  config.default_filter_replacement = '[SECRET]'   # optional
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/rest_client/core_ext/logged_request.rb

@@ -1,60 +1,42 @@
 module LoggedRequest
-  PATTERN = 'rest_client.request'.freeze
-  DEFAULT_CONTENT_TYPE = 'application/json'.freeze
-
   def logged_request(opts = {}, &block)
     # We intend on using the following variables in this method's
     # ensure block. This means that we must take care to ensure
     # that we check for nil against these variables whenever they
     # are accessed.
-    response, exception = nil, nil
     started = Time.now
+    log_request(opts, started)
+    response, exception = nil, nil
     response = execute(opts, &block)
   rescue StandardError => ex
     exception = ex.class.to_s
-    response = ex.respond_to?(:response) && ex.response
+    response = ex.respond_to?(:response) ? ex.response : nil
     raise ex # Re-raise the exception, we just wanted to capture it
   ensure
-    time = (Time.now - started).round(2)
-    content_type = content_type_from_headers(opts[:headers])
-    payload = filter(content_type).new(data: opts[:payload]).filter
-    opts[:headers].reject! { |k, _| k.to_s.casecmp('authorization').zero? } if opts[:headers]
-    params = opts.except(:user, :password, :payload).merge(payload: payload)
-    ActiveSupport::Notifications.instrument PATTERN,
-      log_data(params, response, exception, time)
+    logged_response = opts.merge(exception: exception, response: response)
+    ActiveSupport::Notifications.instrument(
+      RestClient::Jogger.response_pattern,
+      log_payload(logged_response, started)
+    )
   end
 
   private
 
-  def log_data(params, response, exception, time)
-    request_data(params).merge(
-      response: response_data(response),
-      exception: exception,
-      time_elapsed: time
+  def log_payload(params, started)
+    params.merge(
+      headers: filtered_headers(params),
+      start_time: started
     )
   end
 
-  def response_data(response = nil)
-    if response
-      {
-        code: response.code,
-        headers: response.headers.reject { |k, _| k.to_s.casecmp('authorization').zero? },
-        body: response.body.to_s.force_encoding('UTF-8')
-      }
-    end
+  def filtered_headers(opts)
+    opts.fetch(:headers, {}).reject { |k, _| k.to_s.casecmp('authorization').zero? }
   end
 
-  def request_data(params)
-    {
-      request: params
-    }
-  end
-
-  def filter(content_type)
-    RestClient::Jogger::Filters::Base.filter_class(content_type)
-  end
-
-  def content_type_from_headers(headers)
-    (headers && headers[:content_type]) || DEFAULT_CONTENT_TYPE
+  def log_request(opts, started)
+    ActiveSupport::Notifications.instrument(
+      RestClient::Jogger.request_pattern,
+      log_payload(opts, started)
+    )
   end
 end

data/lib/rest_client/jogger/action.rb

@@ -0,0 +1,59 @@
+module RestClient
+  module Jogger
+    class Action
+      include ActiveModel::Model
+      attr_accessor :logger, :notifier
+
+      def initialize(args = {})
+        self.logger = args.fetch :logger
+        super
+      end
+
+      def notifier
+        @notifier ||= ::Rollbar
+      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
+        name =~ /error/ ? logger.error(json) : logger.debug(json)
+      rescue StandardError => e
+        notifier.error e, payload: payload
+      end
+
+      def template
+        raise NotImplementedError, 'define a #template method in a subclass'
+      end
+
+      private
+
+      def filter(opts = {})
+        filter_class(opts[:headers] || {}).new(data: opts[:payload].to_s).filter
+      end
+
+      def filter_class(headers = {})
+        content_type = headers.fetch(:content_type) { 'application/json' }
+        RestClient::Jogger::Filters::Base.filter_class(content_type)
+      end
+
+      def root
+        Pathname.new(ROOT_PATH).freeze
+      end
+
+      def ip_address
+        Socket.ip_address_list.select(&:ipv4_private?).first.try(:ip_address)
+      end
+    end
+  end
+end

data/lib/rest_client/jogger/configuration.rb

@@ -0,0 +1,34 @@
+module RestClient
+  module Jogger
+    class Configuration
+      include ActiveModel::Model
+
+      REQUIRED_ATTRIBUTES = %i().freeze
+      OPTIONAL_ATTRIBUTES = %i(
+        request_pattern
+        response_pattern
+        default_content_type
+        default_filter_replacement
+      ).freeze
+      ATTRIBUTES = (REQUIRED_ATTRIBUTES | OPTIONAL_ATTRIBUTES).freeze
+
+      attr_accessor *ATTRIBUTES
+
+      def request_pattern
+        @request_pattern || 'rest_client.request'
+      end
+
+      def response_pattern
+        @response_pattern || 'rest_client.response'
+      end
+
+      def default_content_type
+        @default_content_type || 'application/json'
+      end
+
+      def default_filter_replacement
+        @default_filter_replacement || '[FILTERED]'
+      end
+    end
+  end
+end

data/lib/rest_client/jogger/event_subscriber.rb

@@ -7,14 +7,18 @@ module RestClient
         @logger ||= ActiveSupport::Logger.new('log/rest_client.log').tap { |l| l.level = Logger::DEBUG }
       end
 
-      def pattern
-        LoggedRequest::PATTERN
+      def request_pattern
+        RestClient::Jogger.request_pattern
       end
 
-      def subscribe
-        ActiveSupport::Notifications.subscribe pattern, RequestComplete.new(logger: logger)
+      def response_pattern
+        RestClient::Jogger.response_pattern
       end
 
+      def subscribe
+        ActiveSupport::Notifications.subscribe request_pattern, Request.new(logger: logger)
+        ActiveSupport::Notifications.subscribe response_pattern, Response.new(logger: logger)
+      end
     end
   end
 end

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

@@ -2,8 +2,6 @@ module RestClient
   module Jogger
     module Filters
       class Base
-        DEFAULT_REPLACEMENT = '[FILTERED]'.freeze
-
         include ActiveModel::Model
 
         attr_accessor :data, :content_type, :filters, :filter_replacement
@@ -17,6 +15,11 @@ module RestClient
           end
         end
 
+        def initialize(opts = {})
+          super
+          self.data = data.dup
+        end
+
         def filter
           filters.each do |filter|
             filter_data filter
@@ -29,7 +32,7 @@ module RestClient
         end
 
         def filter_replacement
-          @filter_replacement ||= DEFAULT_REPLACEMENT
+          @filter_replacement ||= RestClient::Jogger.default_filter_replacement
         end
 
         def filters
@@ -37,7 +40,7 @@ module RestClient
         end
 
         def content_type
-          @content_type ||= 'application/json'
+          @content_type ||= RestClient::Jogger.default_content_type
         end
 
       private

data/lib/rest_client/jogger/request.rb

@@ -0,0 +1,9 @@
+module RestClient
+  module Jogger
+    class Request < Action
+      def template
+        Tilt::JbuilderTemplate.new root.join('templates', 'request_logging_template.json.jbuilder')
+      end
+    end
+  end
+end

data/lib/rest_client/jogger/response.rb

@@ -0,0 +1,9 @@
+module RestClient
+  module Jogger
+    class Response < Action
+      def template
+        Tilt::JbuilderTemplate.new root.join('templates', 'response_logging_template.json.jbuilder')
+      end
+    end
+  end
+end

data/lib/rest_client/jogger/version.rb

@@ -1,5 +1,5 @@
 module RestClient
   module Jogger
-    VERSION = '0.3.5'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

data/lib/rest_client/jogger.rb

@@ -1,19 +1,42 @@
-require "json"
-require "mime/types"
-require "active_model"
-require "rollbar"
-require "rest_client/jogger/version"
-require "rest_client/jogger/event_subscriber"
-require "rest_client/jogger/request_complete"
-require "rest_client/jogger/filters/base"
-require "rest_client/jogger/filters/json"
-require "rest_client/jogger/filters/xml"
-require "rest_client/core_ext/logged_request"
+require 'json'
+require 'mime/types'
+require 'active_model'
+require 'active_support/all'
+require 'rollbar'
+require 'tilt/jbuilder'
+require 'rest_client/jogger/version'
+require 'rest_client/jogger/configuration'
+require 'rest_client/jogger/event_subscriber'
+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/json'
+require 'rest_client/jogger/filters/xml'
+require 'rest_client/core_ext/logged_request'
 
 module RestClient
   class Request
     extend LoggedRequest
   end
+  
   module Jogger
+    ROOT_PATH = File.expand_path(File.dirname(__FILE__)).freeze
+
+    class << self
+      Configuration::ATTRIBUTES.each do |attribute|
+        delegate attribute, to: :configuration
+      end
+
+      attr_writer :configuration
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def configure
+        yield(configuration)
+      end
+    end
   end
 end

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

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

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

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

data/rest-client-jogger.gemspec

@@ -30,6 +30,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "mime-types"
   spec.add_dependency "rollbar"
+  spec.add_dependency "jbuilder"
+  spec.add_dependency 'tilt'
+  spec.add_dependency 'tilt-jbuilder'
 
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rest-client-jogger
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Jordan Babe
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-30 00:00:00.000000000 Z
+date: 2018-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -68,6 +68,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tilt-jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -217,12 +259,18 @@ files:
 - bin/setup
 - lib/rest_client/core_ext/logged_request.rb
 - lib/rest_client/jogger.rb
+- lib/rest_client/jogger/action.rb
+- 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/json.rb
 - lib/rest_client/jogger/filters/xml.rb
-- lib/rest_client/jogger/request_complete.rb
+- lib/rest_client/jogger/request.rb
+- lib/rest_client/jogger/response.rb
 - lib/rest_client/jogger/version.rb
+- lib/rest_client/templates/request_logging_template.json.jbuilder
+- lib/rest_client/templates/response_logging_template.json.jbuilder
+- rest-client-jogger-0.3.4.gem
 - rest-client-jogger.gemspec
 homepage: https://github.com/amaabca/rest-client-jogger
 licenses:
@@ -244,7 +292,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Logs RestClient requests in a JSON format

data/lib/rest_client/jogger/request_complete.rb

@@ -1,25 +0,0 @@
-module RestClient
-  module Jogger
-    class RequestComplete
-      include ::ActiveModel::Model
-      attr_accessor :logger, :notifier
-
-      def initialize(args = {})
-        self.logger = args.fetch :logger
-        super
-      end
-
-      def notifier
-        @notifier ||= ::Rollbar
-      end
-
-      def call(name, start, finish, id, payload)
-        message = ::JSON.dump(payload.merge(event_name: name, event_id: id, timestamp: start))
-        name =~ /error/ ? logger.error(message) : logger.debug(message)
-      rescue StandardError => e
-        notifier.error e, payload: payload
-      end
-
-    end
-  end
-end