g5-logger 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 029c522b3fe68fc729373e20db3b0af62d86c5ac
+  data.tar.gz: 9b76ed4782d5b609a6b4c252d0960ed1b26a059f
+SHA512:
+  metadata.gz: 16bbc49d56331e18980a113600f2609c81f2d18cc401466b7b486d46d51543a986d99b8264bb7b027529520c879c09c6b2c15a45c06ea819493606b492047c7a
+  data.tar.gz: 090375bb4aefe62dfc7a7a70b203ca5305316e95cb5980b957c0b55edab960fe7545c6db2a47bef8765c99f0f862f3abc3e6dff1cd2ca3ad85df813eca6bb8dd

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+/.idea/
+
+/g5-logger*.gem

data/.ruby-version

@@ -0,0 +1 @@
+2.1.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Perry Hertler
+
+MIT License
+
+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,31 @@
+# G5::Logger
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'g5-logger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install g5-logger
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/g5-logger/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/g5-logger.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'g5/logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name     = "g5-logger"
+  spec.version  = G5::Logger::VERSION
+  spec.authors  = ["Perry Hertler"]
+  spec.email    = ["perry@hertler.org"]
+  spec.summary  = %q{Client gem that logs to the G5-logging-service.}
+  spec.homepage = ""
+  spec.license  = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-its', '~> 1.0'
+  spec.add_development_dependency 'pry-nav', '~> 0.2'
+
+  spec.add_runtime_dependency 'typhoeus', '~> 0.6'
+  spec.add_runtime_dependency 'activesupport', '~> 4.1'
+end

data/lib/g5/logger.rb

@@ -0,0 +1,18 @@
+require 'g5/logger/version'
+require 'g5/logger/log'
+require 'active_support/core_ext'
+
+module G5
+  module Logger
+    KEY_VALUE_FORMAT = 'key_value'
+    JSON_FORMAT      = 'json'
+    # override in your Rails.root/config/initializers
+    Config           = {
+        logger:          'REQUIRED', #usually Rails.logger
+        source_app_name: 'REQUIRED - this is the name of the app using it',
+        format:          JSON_FORMAT, # json or key_value
+        redact_keys:     [/credit/, /password/, /cvv/],
+        redact_value:    '***'
+    }
+  end
+end

data/lib/g5/logger/log.rb

@@ -0,0 +1,74 @@
+module G5
+  module Logger
+    class Log
+      Levels = %w(debug info warn error fatal unknown)
+
+      class << self
+        Levels.each do |name|
+          define_method(name) do |attributes|
+            log({level: name}.merge(attributes))
+          end
+        end
+
+        def log(attributes)
+          default_merge = {source_app_name: Config[:source_app_name]}.merge(attributes)
+          log_level     = level(default_merge.delete(:level))
+          Config[:logger].send(log_level, log_entry(default_merge))
+        end
+
+        def level(level)
+          Levels.include?(level) ? level : :info
+        end
+
+        def log_entry(hash)
+          scrubbed = redact hash.clone
+          if  G5::Logger::KEY_VALUE_FORMAT== G5::Logger::Config[:format]
+            scrubbed.keys.collect { |key| "#{key}=\"#{hash[key]}\"" }.join(", ")
+          else
+            scrubbed.to_json
+          end
+        end
+
+        def log_json_req_resp(request, response, options={})
+          options = options.merge(
+              status:   response.try(:code),
+              request:  request,
+              response: response.try(:body))
+
+          send(log_method(response.code), options)
+        end
+
+        def log_method(code)
+          error = code > 299 rescue false
+          error ? :error : :info
+        end
+
+        def redact(hash)
+          hash.keys.each do |key|
+            redact(hash[key]) if hash[key].kind_of?(Hash)
+            redact_array(hash[key]) if hash[key].kind_of?(Array)
+            hash[key] = Config[:redact_value] if redactable?(key)
+          end
+          hash
+        end
+
+        def redactable?(value)
+          return false if value.blank? || ![String, Symbol].include?(value.class)
+          !!Config[:redact_keys].detect { |rk|
+            if rk.class == String
+              rk == value
+            else
+              value.match(rk)
+            end
+          }
+        end
+
+        def redact_array(array)
+          array.each do |array_val|
+            redact array_val if array_val.kind_of?(Hash)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/g5/logger/version.rb

@@ -0,0 +1,5 @@
+module G5
+  module Logger
+    VERSION = "0.0.5"
+  end
+end

data/spec/g5/logger/log_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+describe G5::Logger::Log do
+  context 'json' do
+    before { G5::Logger::Config[:format] = G5::Logger::JSON_FORMAT }
+
+    describe 'redact sensitive data' do
+      before do
+        G5::Logger::Config[:redact_keys] << 'redactme'
+      end
+      let(:request) { {'credit_card' => '4344122144442222', foo: 'bar', parent: {cvv: '323', jimmy: 'joe'}, 'array' => [{'my_password' => 'jimpass', 'redactme' => 'secretval'}]} }
+      let(:body) { {credit_exp_date: '10/2015', whatever: 'brah'} }
+      let(:response) { double(:response, code: 201, body: body) }
+      let(:redact_value) {G5::Logger::Config[:redact_value]}
+
+      subject do
+        G5::Logger::Log.log_json_req_resp(request, response, {foo: 'bar', 'j_cvv' => 343})
+        indifferent_hash_from_json TestLogger.last_payload
+      end
+
+      it { is_expected.to eq({"source_app_name" => "test", "foo" => "bar", "j_cvv" => redact_value, "status" => 201,
+                              "request"         => {"credit_card" => redact_value, "foo" => "bar",
+                                                    "parent"      => {"cvv" => redact_value, "jimmy" => "joe"},
+                                                    "array"       => [{"my_password" => redact_value, "redactme" => redact_value}]},
+                              "response"        => {"credit_exp_date" => redact_value, "whatever" => "brah"}}) }
+    end
+
+    describe :log_json_req_resp do
+      let(:request) { {payload: 'foo'} }
+      let(:code) { 201 }
+      let(:body) { {model: {id: 1, name: 'yeah'}} }
+      let(:response) { double(:response, code: code, body: body) }
+      subject do
+        G5::Logger::Log.log_json_req_resp(request, response, {foo: 'bar'})
+        indifferent_hash_from_json TestLogger.last_payload
+      end
+
+      its([:source_app_name]) { is_expected.to eq('test') }
+      its([:foo]) { is_expected.to eq('bar') }
+      its([:status]) { is_expected.to eq(201) }
+      its([:response]) { is_expected.to eq({"model" => {"id" => 1, "name" => "yeah"}}) }
+      its([:request]) { is_expected.to eq({"payload" => "foo"}) }
+    end
+  end
+
+  context 'key_value' do
+    before { G5::Logger::Config[:format] = G5::Logger::KEY_VALUE_FORMAT }
+
+    describe 'levels' do
+      G5::Logger::Log::Levels.each do |method|
+        it "delegates #{method} to log method" do
+          expect(TestLogger).to receive(method).with("source_app_name=\"test\", foo=\"bar\"")
+          G5::Logger::Log.send(method, foo: 'bar')
+        end
+      end
+    end
+
+    describe :log do
+      let(:params) do
+        {source_name:                 'test',
+         level:                       3,
+         external_parent_id:          33,
+         external_parent_source_name: 'g5-jobs',
+         title:                       'attachments title',
+         request:                     '<request></request>',
+         response:                    {foo: 'bar'}.to_json
+        }
+      end
+      subject do
+        G5::Logger::Log.log(params)
+        TestLogger.last_payload
+      end
+      it { is_expected.to eq("source_app_name=\"test\", source_name=\"test\", external_parent_id=\"33\", external_parent_source_name=\"g5-jobs\", title=\"attachments title\", request=\"<request></request>\", response=\"{\"foo\":\"bar\"}\"") }
+    end
+
+    describe :log_json_req_resp do
+      let(:request) { 'req' }
+      let(:code) { 201 }
+      let(:body) { 'body' }
+      let(:response) { double(:response, code: code, body: body) }
+      subject do
+        G5::Logger::Log.log_json_req_resp(request, response, {foo: 'bar'})
+        TestLogger.last_payload
+      end
+      it { is_expected.to eq("source_app_name=\"test\", foo=\"bar\", status=\"201\", request=\"req\", response=\"body\"") }
+    end
+
+    describe :log_method do
+      [{code: 201, expected: :info}, {code: 300, expected: :error}, {code: nil, expected: :info}].each do |test_hash|
+        it "uses #{test_hash[:expected]} when code is #{test_hash[:code]}" do
+          expect(G5::Logger::Log.log_method(test_hash[:code])).to eq(test_hash[:expected])
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'g5/logger'
+require 'pry'
+require 'rspec/its'
+
+ROOTPATH = File.expand_path('..', __FILE__)
+Dir[File.join(ROOTPATH, 'support/**/*.rb')].each { |support| require support }
+G5::Logger::Config[:logger]          = TestLogger
+G5::Logger::Config[:source_app_name] = 'test'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end
+
+def indifferent_hash_from_json(json)
+  ActiveSupport::HashWithIndifferentAccess.new(JSON.parse(json))
+end
+

data/spec/support/test_logger.rb

@@ -0,0 +1,22 @@
+class TestLogger
+  Levels = [
+      :debug, :info, :warn, :error, :fatal, :unknown
+  ]
+
+  class << self
+    Levels.each do |name|
+      define_method(name) do |payload|
+        @@last_payload = payload
+        @@last_level   = name
+      end
+    end
+
+    def last_payload
+      @@last_payload
+    end
+
+    def last_level
+      @@last_level
+    end
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: g5-logger
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Perry Hertler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+description: 
+email:
+- perry@hertler.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- g5-logger.gemspec
+- lib/g5/logger.rb
+- lib/g5/logger/log.rb
+- lib/g5/logger/version.rb
+- spec/g5/logger/log_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_logger.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Client gem that logs to the G5-logging-service.
+test_files:
+- spec/g5/logger/log_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_logger.rb