rest-client-jogger 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 500615aa5468f9e71cd899d2e3610af428a6e5f6
+  data.tar.gz: c739106fd9ae51b3168c282e0a2e104a21d985ce
+SHA512:
+  metadata.gz: 5d6da1310c7b75280d710515f9cb81b8f1e294eec0b4114cb086fde119bc217eb40f268dce9aafcf1511ea5b9ea96aaf49a1b504a3c77eb1b897f9f1dba6e4b8
+  data.tar.gz: a5a9191598f41a1467fdd30a7a15325c0d6461f990abe649aded49884a2d9f7b4e0a169b0c99b010cf95d81a61b63de6c94cae889117069650f3bd64263e9ad1

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/log/
+/vendor/bundle
+.DS_Store

data/.rspec

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

data/.simplecov

@@ -0,0 +1,5 @@
+SimpleCov.start do
+  SimpleCov.minimum_coverage 100.0
+  add_filter "/spec"
+  add_filter "/vendor"
+end

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.2
+  - 2.2.0
+  - 2.2.1
+  - 2.2.2
+  - 2.2.3
+  - 2.3.0
+before_install: gem install bundler -v 1.12.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rest-client-jogger.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alberta Motor Assocation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# RestClient::Jogger
+
+JSON Logger for RestClient
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rest-client-jogger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rest-client-jogger
+
+## Usage
+
+The `logged_request` method is the primary interaction with this gem.
+
+You can call `RestClient::Request.logged_request` in place of `RestClient::Request.execute`. The `logged_request` method will send a notification to an `ActiveSupport::Notifications` subscriber.
+
+Here's how to setup the event subscriber in a Rails application:
+
+```ruby
+# in an initializer somewhere
+require 'rest_client/jogger'
+
+RestClient::Jogger::EventSubscriber.new.subscribe
+```
+
+This will log all requests made with the `logged_request` method to a logfile in `log/rest_client.log`.
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/amaabca/rest-client-jogger.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new :spec
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rest/client/jogger"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/rake

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rest_client/core_ext/logged_request.rb

@@ -0,0 +1,59 @@
+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
+    response = execute(opts, &block)
+  rescue StandardError => ex
+    exception = ex.class.to_s
+    response = ex.respond_to?(:response) && ex.response
+    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
+    params = opts.except(:user, :password, :payload).merge(payload: payload)
+    ActiveSupport::Notifications.instrument PATTERN,
+      log_data(params, response, exception, time)
+  end
+
+  private
+
+  def log_data(params, response, exception, time)
+    request_data(params).merge(
+      response: response_data(response),
+      exception: exception,
+      time_elapsed: time
+    )
+  end
+
+  def response_data(response = nil)
+    if response
+      {
+        code: response.code,
+        headers: response.headers,
+        body: response.body.to_s.force_encoding('UTF-8')
+      }
+    end
+  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
+  end
+end

data/lib/rest_client/jogger.rb

@@ -0,0 +1,19 @@
+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"
+
+module RestClient
+  class Request
+    extend LoggedRequest
+  end
+  module Jogger
+  end
+end

data/lib/rest_client/jogger/event_subscriber.rb

@@ -0,0 +1,20 @@
+module RestClient
+  module Jogger
+    class EventSubscriber
+      attr_accessor :logger
+
+      def logger
+        @logger ||= ActiveSupport::Logger.new('log/rest_client.log').tap { |l| l.level = Logger::DEBUG }
+      end
+
+      def pattern
+        LoggedRequest::PATTERN
+      end
+
+      def subscribe
+        ActiveSupport::Notifications.subscribe pattern, RequestComplete.new(logger: logger)
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+module RestClient
+  module Jogger
+    module Filters
+      class Base
+        DEFAULT_REPLACEMENT = '[FILTERED]'.freeze
+
+        include ActiveModel::Model
+
+        attr_accessor :data, :content_type, :filters, :filter_replacement
+
+        def self.filter_class(content_type)
+          type = MIME::Types[content_type].first
+          if type && type.sub_type == 'xml'
+            RestClient::Jogger::Filters::Xml
+          else
+            RestClient::Jogger::Filters::Json
+          end
+        end
+
+        def filter
+          filters.each do |filter|
+            filter_data filter
+          end
+          data
+        end
+
+        def data
+          @data ||= ''
+        end
+
+        def filter_replacement
+          @filter_replacement ||= DEFAULT_REPLACEMENT
+        end
+
+        def filters
+          @filters ||= filter_parameters
+        end
+
+        def content_type
+          @content_type ||= 'application/json'
+        end
+
+      private
+
+        def filter_parameters
+          defined?(Rails) ? Rails.configuration.filter_parameters : []
+        end
+
+        def filter_data(filter)
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

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

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

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

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

data/lib/rest_client/jogger/request_complete.rb

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

data/lib/rest_client/jogger/version.rb

@@ -0,0 +1,5 @@
+module RestClient
+  module Jogger
+    VERSION = '0.3.2'.freeze
+  end
+end

data/rest-client-jogger.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rest_client/jogger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rest-client-jogger"
+  spec.version       = RestClient::Jogger::VERSION
+  spec.authors       = ["Jordan Babe", "Jesse Doyle", "Michael van den Beuken"]
+  spec.email         = ["jordan.babe@ama.ab.ca", "jesse.doyle@ama.ab.ca", "michael.beuken@gmail.com"]
+
+  spec.summary       = %q{Logs RestClient requests in a JSON format}
+  spec.description   = %q{Logs RestClient requests in a JSON format.}
+  spec.homepage      = "https://github.com/amaabca/rest-client-jogger"
+  spec.license       = "MIT"
+
+  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"]
+
+  # Rails/ActiveModel/ActiveSupport 5.0.X requires ruby >= 2.2.2
+  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.2.2')
+    spec.add_dependency "activesupport", '>= 4.2'
+    spec.add_dependency "activemodel", '>= 4.2'
+  else
+    spec.add_dependency "activesupport", '~> 4.2'
+    spec.add_dependency "activemodel", '~> 4.2'
+  end
+
+  spec.add_dependency "mime-types"
+  spec.add_dependency "rollbar"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-json_expectations"
+  spec.add_development_dependency "rest-client", "~> 2.0.0"
+  spec.add_development_dependency "nokogiri"
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,251 @@
+--- !ruby/object:Gem::Specification
+name: rest-client-jogger
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+platform: ruby
+authors:
+- Jordan Babe
+- Jesse Doyle
+- Michael van den Beuken
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  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: rollbar
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-json_expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Logs RestClient requests in a JSON format.
+email:
+- jordan.babe@ama.ab.ca
+- jesse.doyle@ama.ab.ca
+- michael.beuken@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/rspec
+- bin/setup
+- lib/rest_client/core_ext/logged_request.rb
+- lib/rest_client/jogger.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/version.rb
+- rest-client-jogger.gemspec
+homepage: https://github.com/amaabca/rest-client-jogger
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Logs RestClient requests in a JSON format
+test_files: []