loga 1.0.0

data/spec/unit/loga/rack/request_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Loga::Rack::Request do
+  let(:options)   { {} }
+  let(:full_path) { '/' }
+  let(:env)       { Rack::MockRequest.env_for(full_path, options) }
+
+  subject { described_class.new(env) }
+
+  describe '#uuid' do
+    let(:action_dispatch_request_id) { 'ABCD' }
+
+    context 'when ACTION_DISPATCH_REQUEST_ID present' do
+      let(:options) do
+        { 'action_dispatch.request_id' => action_dispatch_request_id }
+      end
+      it 'returns the middleware value' do
+        expect(subject.uuid).to eq(action_dispatch_request_id)
+      end
+    end
+
+    context 'when ACTION_DISPATCH_REQUEST_ID blank' do
+      it 'returns nil' do
+        expect(subject.uuid).to be_nil
+      end
+    end
+  end
+
+  describe '#original_path' do
+    let(:path)    { 'users/5/oranges' }
+    let(:options) { { 'loga.request.original_path' => path } }
+
+    it 'returns path based on loga request env' do
+      expect(subject.original_path).to eq(path)
+    end
+  end
+
+  describe '#filtered_full_path' do
+    let(:config) { double :config, filter_parameters: [:password] }
+
+    let(:path)         { '/hello' }
+    let(:query)        { { 'password' => 123, 'color' => 'red' }  }
+    let(:query_string) { Rack::Utils.build_query(query) }
+    let(:full_path)    { "#{path}?#{query_string}" }
+
+    let(:options) { { 'loga.request.original_path' => path } }
+
+    before do
+      allow(Loga).to receive(:configuration).and_return(config)
+    end
+
+    context 'request with sensitive parameters' do
+      it 'returns the path with sensitive parameters filtered' do
+        expect(subject.filtered_full_path).to eq('/hello?password=[FILTERED]&color=red')
+      end
+    end
+
+    it 'memoizes the result' do
+      expect(subject.filtered_full_path).to equal(subject.filtered_full_path)
+    end
+  end
+
+  describe '#filtered_parameters' do
+    pending 'returns both query and form filered parameters'
+
+    it 'memoizes the result' do
+      expect(subject.filtered_parameters).to equal(subject.filtered_parameters)
+    end
+  end
+end

data/spec/unit/loga/utilities_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Loga::Utilities do
+  subject { Object.new.extend(Loga::Utilities) }
+
+  describe 'duration_in_ms#(started_at, ended_at)' do
+    let(:start_time) { Time.new(2002, 10, 31, 2, 2, 2.0) }
+    let(:end_time)   { Time.new(2002, 10, 31, 2, 2, 2.6789) }
+
+    subject { super().duration_in_ms(start_time, end_time) }
+
+    it 'calculates elapsed time rounding the nearest millisecond' do
+      expect(subject).to eq(679)
+    end
+  end
+end

data/spec/unit/loga_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Loga do
+  before { described_class.reset }
+
+  describe '.configuration' do
+    specify { expect(subject.configuration).to be_instance_of(Loga::Configuration) }
+
+    it 'memoizes the result' do
+      expect(subject.configuration).to equal(subject.configuration)
+    end
+  end
+
+  describe '.configure' do
+    it 'configures Loga' do
+      expect { |b| subject.configure(&b) }.to yield_with_args(subject.configuration)
+    end
+  end
+
+  describe '.initialize!' do
+    it 'initializes Loga' do
+      expect { subject.initialize! }.to_not raise_error
+    end
+  end
+
+  describe '.logger' do
+    context 'when Loga is not initialized' do
+      specify { expect(subject.logger).to be_nil }
+    end
+    context 'when Loga is initialized' do
+      before { Loga.initialize! }
+      specify { expect(subject.logger).to be_kind_of(Logger) }
+    end
+  end
+
+  describe '.reset' do
+    it 'resets the configuration' do
+      expect { subject.reset }.to change { subject.configuration.object_id }
+    end
+  end
+end

metadata

@@ -0,0 +1,357 @@
+--- !ruby/object:Gem::Specification
+name: loga
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Funding Circle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.8
+- !ruby/object:Gem::Dependency
+  name: rack
+  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: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: rack-test
+  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: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.30.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.30.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: Log aggregation through unified logging middleware, while respecting
+  the original log format.
+email:
+- engineering@fundingcircle.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Appraisals
+- Gemfile
+- README.md
+- Rakefile
+- circle.yml
+- gemfiles/rails32.gemfile
+- gemfiles/rails40.gemfile
+- gemfiles/sinatra14.gemfile
+- gemfiles/unit.gemfile
+- lib/loga.rb
+- lib/loga/configuration.rb
+- lib/loga/event.rb
+- lib/loga/ext/rails/rack/logger3.rb
+- lib/loga/ext/rails/rack/logger4.rb
+- lib/loga/formatter.rb
+- lib/loga/parameter_filter.rb
+- lib/loga/rack/logger.rb
+- lib/loga/rack/request.rb
+- lib/loga/rack/request_id.rb
+- lib/loga/railtie.rb
+- lib/loga/tagged_logging.rb
+- lib/loga/utilities.rb
+- lib/loga/version.rb
+- loga.gemspec
+- spec/fixtures/README.md
+- spec/fixtures/rails32/Rakefile
+- spec/fixtures/rails32/app/controllers/application_controller.rb
+- spec/fixtures/rails32/app/helpers/application_helper.rb
+- spec/fixtures/rails32/app/views/layouts/application.html.erb
+- spec/fixtures/rails32/app/views/user.html.erb
+- spec/fixtures/rails32/config.ru
+- spec/fixtures/rails32/config/application.rb
+- spec/fixtures/rails32/config/boot.rb
+- spec/fixtures/rails32/config/environment.rb
+- spec/fixtures/rails32/config/environments/development.rb
+- spec/fixtures/rails32/config/environments/production.rb
+- spec/fixtures/rails32/config/environments/test.rb
+- spec/fixtures/rails32/config/initializers/backtrace_silencers.rb
+- spec/fixtures/rails32/config/initializers/inflections.rb
+- spec/fixtures/rails32/config/initializers/mime_types.rb
+- spec/fixtures/rails32/config/initializers/secret_token.rb
+- spec/fixtures/rails32/config/initializers/session_store.rb
+- spec/fixtures/rails32/config/initializers/wrap_parameters.rb
+- spec/fixtures/rails32/config/locales/en.yml
+- spec/fixtures/rails32/config/routes.rb
+- spec/fixtures/rails32/public/404.html
+- spec/fixtures/rails32/public/422.html
+- spec/fixtures/rails32/public/500.html
+- spec/fixtures/rails32/public/favicon.ico
+- spec/fixtures/rails32/public/index.html
+- spec/fixtures/rails32/public/robots.txt
+- spec/fixtures/rails32/script/rails
+- spec/fixtures/rails40/Rakefile
+- spec/fixtures/rails40/app/controllers/application_controller.rb
+- spec/fixtures/rails40/app/helpers/application_helper.rb
+- spec/fixtures/rails40/app/views/layouts/application.html.erb
+- spec/fixtures/rails40/app/views/user.html.erb
+- spec/fixtures/rails40/bin/bundle
+- spec/fixtures/rails40/bin/rails
+- spec/fixtures/rails40/bin/rake
+- spec/fixtures/rails40/config.ru
+- spec/fixtures/rails40/config/application.rb
+- spec/fixtures/rails40/config/boot.rb
+- spec/fixtures/rails40/config/environment.rb
+- spec/fixtures/rails40/config/environments/development.rb
+- spec/fixtures/rails40/config/environments/production.rb
+- spec/fixtures/rails40/config/environments/test.rb
+- spec/fixtures/rails40/config/initializers/backtrace_silencers.rb
+- spec/fixtures/rails40/config/initializers/filter_parameter_logging.rb
+- spec/fixtures/rails40/config/initializers/inflections.rb
+- spec/fixtures/rails40/config/initializers/mime_types.rb
+- spec/fixtures/rails40/config/initializers/secret_token.rb
+- spec/fixtures/rails40/config/initializers/session_store.rb
+- spec/fixtures/rails40/config/initializers/wrap_parameters.rb
+- spec/fixtures/rails40/config/locales/en.yml
+- spec/fixtures/rails40/config/routes.rb
+- spec/fixtures/rails40/public/404.html
+- spec/fixtures/rails40/public/422.html
+- spec/fixtures/rails40/public/500.html
+- spec/fixtures/rails40/public/favicon.ico
+- spec/fixtures/rails40/public/robots.txt
+- spec/integration/rails/railtie_spec.rb
+- spec/integration/rails/request_spec.rb
+- spec/integration/sinatra_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb
+- spec/support/request_spec.rb
+- spec/support/timecop_shared.rb
+- spec/unit/loga/configuration_spec.rb
+- spec/unit/loga/event_spec.rb
+- spec/unit/loga/formatter_spec.rb
+- spec/unit/loga/parameter_filter_spec.rb
+- spec/unit/loga/rack/logger_spec.rb
+- spec/unit/loga/rack/request_spec.rb
+- spec/unit/loga/utilities_spec.rb
+- spec/unit/loga_spec.rb
+homepage: https://github.com/FundingCircle/loga
+licenses: []
+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: Facilitate log aggregation via unified logging
+test_files:
+- spec/fixtures/README.md
+- spec/fixtures/rails32/Rakefile
+- spec/fixtures/rails32/app/controllers/application_controller.rb
+- spec/fixtures/rails32/app/helpers/application_helper.rb
+- spec/fixtures/rails32/app/views/layouts/application.html.erb
+- spec/fixtures/rails32/app/views/user.html.erb
+- spec/fixtures/rails32/config.ru
+- spec/fixtures/rails32/config/application.rb
+- spec/fixtures/rails32/config/boot.rb
+- spec/fixtures/rails32/config/environment.rb
+- spec/fixtures/rails32/config/environments/development.rb
+- spec/fixtures/rails32/config/environments/production.rb
+- spec/fixtures/rails32/config/environments/test.rb
+- spec/fixtures/rails32/config/initializers/backtrace_silencers.rb
+- spec/fixtures/rails32/config/initializers/inflections.rb
+- spec/fixtures/rails32/config/initializers/mime_types.rb
+- spec/fixtures/rails32/config/initializers/secret_token.rb
+- spec/fixtures/rails32/config/initializers/session_store.rb
+- spec/fixtures/rails32/config/initializers/wrap_parameters.rb
+- spec/fixtures/rails32/config/locales/en.yml
+- spec/fixtures/rails32/config/routes.rb
+- spec/fixtures/rails32/public/404.html
+- spec/fixtures/rails32/public/422.html
+- spec/fixtures/rails32/public/500.html
+- spec/fixtures/rails32/public/favicon.ico
+- spec/fixtures/rails32/public/index.html
+- spec/fixtures/rails32/public/robots.txt
+- spec/fixtures/rails32/script/rails
+- spec/fixtures/rails40/Rakefile
+- spec/fixtures/rails40/app/controllers/application_controller.rb
+- spec/fixtures/rails40/app/helpers/application_helper.rb
+- spec/fixtures/rails40/app/views/layouts/application.html.erb
+- spec/fixtures/rails40/app/views/user.html.erb
+- spec/fixtures/rails40/bin/bundle
+- spec/fixtures/rails40/bin/rails
+- spec/fixtures/rails40/bin/rake
+- spec/fixtures/rails40/config.ru
+- spec/fixtures/rails40/config/application.rb
+- spec/fixtures/rails40/config/boot.rb
+- spec/fixtures/rails40/config/environment.rb
+- spec/fixtures/rails40/config/environments/development.rb
+- spec/fixtures/rails40/config/environments/production.rb
+- spec/fixtures/rails40/config/environments/test.rb
+- spec/fixtures/rails40/config/initializers/backtrace_silencers.rb
+- spec/fixtures/rails40/config/initializers/filter_parameter_logging.rb
+- spec/fixtures/rails40/config/initializers/inflections.rb
+- spec/fixtures/rails40/config/initializers/mime_types.rb
+- spec/fixtures/rails40/config/initializers/secret_token.rb
+- spec/fixtures/rails40/config/initializers/session_store.rb
+- spec/fixtures/rails40/config/initializers/wrap_parameters.rb
+- spec/fixtures/rails40/config/locales/en.yml
+- spec/fixtures/rails40/config/routes.rb
+- spec/fixtures/rails40/public/404.html
+- spec/fixtures/rails40/public/422.html
+- spec/fixtures/rails40/public/500.html
+- spec/fixtures/rails40/public/favicon.ico
+- spec/fixtures/rails40/public/robots.txt
+- spec/integration/rails/railtie_spec.rb
+- spec/integration/rails/request_spec.rb
+- spec/integration/sinatra_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb
+- spec/support/request_spec.rb
+- spec/support/timecop_shared.rb
+- spec/unit/loga/configuration_spec.rb
+- spec/unit/loga/event_spec.rb
+- spec/unit/loga/formatter_spec.rb
+- spec/unit/loga/parameter_filter_spec.rb
+- spec/unit/loga/rack/logger_spec.rb
+- spec/unit/loga/rack/request_spec.rb
+- spec/unit/loga/utilities_spec.rb
+- spec/unit/loga_spec.rb
+has_rdoc: