grape-middleware-logger 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8674fefb691a3aa13fc0f8aa6ec1598fe93fdd88
-  data.tar.gz: 88e7857d7d75146f31e359fa3bbc665d1283e86b
+  metadata.gz: 3669f6ad5c3a84da925373a79582e997b707fd3a
+  data.tar.gz: 94f09b4036667d394c5f794eab4782aedf656bb6
 SHA512:
-  metadata.gz: 88cdf493d9648813e6b2a936549f5ba7b3199aa745798624bae63b4cf6f57ccfcb64fbd2ee737053ec8096b5619583be0dba7cefd4966838caccc36cbd9ee2cf
-  data.tar.gz: 67888e1091ac47590638f4706178b51c76184afd504e80c2ba6d3315f969855ee6bd8f6599cea405df34325f731ed6066a22fd0cac4d6b759fc03f62e9a1c0b9
+  metadata.gz: 80804fc3261ce716e57e458c32381f4bb83c330fd6801f901d394b22a62d68d5b0574b197e9b3bf3467f5bcc633a2e0d1754beef86a239d04cd1dbe63dd4c63a
+  data.tar.gz: 46d9aadf9b6ee7ea7ff9201e2dc8dd596f53d9727d2c25b6c1a8de919fa592ab7dd420ce8a9a4302f406afdf5668c9f150c470cd6d4ee10b31b90f6fba961b34

data/.travis.yml

@@ -5,3 +5,5 @@ rvm:
   - 2.2.2
   - 2.2.3
 before_install: gem install bundler -v 1.10.5
+script:
+  - bin/test

data/Gemfile

@@ -6,4 +6,5 @@ gemspec
 group :test do
   gem 'rake'
   gem "factory_girl", "~> 4.0"
+  gem "rails", "~> 4.2"
 end

data/README.md

@@ -23,15 +23,12 @@ end
 
 Server requests will be logged to STDOUT by default.
 
-#### Rails
-Using Grape with Rails? The `Rails.logger` will be used by default.
-
-#### Custom setup
+## Custom setup
 Customize the logging by passing the `logger` option. Example using a CustomLogger and parameter sanitization:
 ```ruby
 use Grape::Middleware::Logger, {
   logger: CustomLogger.new,
-  filter: ActionDispatch::Http::ParameterFilter.new(Rails.application.config.filter_parameters)
+  filter: CustomFilter.new
 }
 ```
 The `logger` option can be any object that responds to `.info(msg)`
@@ -55,6 +52,34 @@ Processing by ReportsAPI#reports
 Completed 422 in 6.29ms
 ```
 
+## Using Rails?
+`Rails.logger` and `Rails.application.config.filter_parameters` will be used automatically as the default logger and 
+param filterer, respectively.
+
+You may want to disable Rails logging for API endpoints, so that the logging doesn't double-up. You can achieve this 
+by switching around some middleware. For example:
+
+```ruby
+# config/application.rb
+config.middleware.delete 'Rails::Rack::Logger'
+config.middleware.insert_after 'ActionDispatch::RequestId', 'SelectiveLogger'
+
+# config/initializers/selective_logger.rb
+class SelectiveLogger
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    if env['PATH_INFO'] =~ %r{^/api}
+      @app.call(env)
+    else
+      Rails::Rack::Logger.new(@app).call(env)
+    end
+  end
+end
+```
+
 ## Rack
 
 If you're using the `rackup` command to run your server in development, pass the `-q` flag to silence the default rack logger.

data/bin/test

@@ -0,0 +1,3 @@
+#!/bin/bash
+set -ev
+bundle exec rspec spec/lib && bundle exec rspec spec/integration && bundle exec rspec spec/integration_rails

data/grape-middleware-logger.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'grape-middleware-logger'
-  spec.version       = '1.4.2'
+  spec.version       = '1.5.0'
   spec.platform      = Gem::Platform::RUBY
   spec.authors       = ['Ryan Buckley']
   spec.email         = ['arebuckley@gmail.com']

data/lib/grape/middleware/logger.rb

@@ -3,22 +3,30 @@ require 'grape'
 
 class Grape::Middleware::Logger < Grape::Middleware::Globals
   BACKSLASH = '/'.freeze
-  BLANK_SPACE = ''.freeze
 
   attr_reader :logger
 
+  class << self
+    attr_accessor :logger, :filter
+
+    def default_logger
+      default = Logger.new(STDOUT)
+      default.formatter = ->(*args) { args.last.to_s << "\n".freeze }
+      default
+    end
+  end
+
   def initialize(_, options = {})
     super
-    @logger = options[:logger]
-    @logger ||= Rails.logger if defined?(Rails) && Rails.logger.present?
-    @logger ||= default_logger
+    @options[:filter] ||= self.class.filter
+    @logger = options[:logger] || self.class.logger || self.class.default_logger
   end
 
   def before
     start_time
     # sets env['grape.*']
     super
-    logger.info BLANK_SPACE
+    logger.info ''
     logger.info %Q(Started %s "%s" at %s) % [
       env[Grape::Env::GRAPE_REQUEST].request_method,
       env[Grape::Env::GRAPE_REQUEST].path,
@@ -60,7 +68,7 @@ class Grape::Middleware::Logger < Grape::Middleware::Globals
 
   def after(status)
     logger.info "Completed #{status} in #{((Time.now - start_time) * 1000).round(2)}ms"
-    logger.info BLANK_SPACE
+    logger.info ''
   end
 
   #
@@ -93,14 +101,8 @@ class Grape::Middleware::Logger < Grape::Middleware::Globals
 
   def processed_by
     endpoint = env[Grape::Env::API_ENDPOINT]
-    parts = endpoint.options[:for].to_s
-    parts << endpoint.namespace if endpoint.namespace != BACKSLASH
-    parts << '#'.freeze << endpoint.options[:path].map { |path| path.to_s.sub(BACKSLASH, BLANK_SPACE) }.join(BACKSLASH)
-  end
-
-  def default_logger
-    default = Logger.new(STDOUT)
-    default.formatter = ->(*args) { args.last.to_s << "\n".freeze }
-    default
+    endpoint.options[:for].to_s << '#'.freeze << endpoint.options[:path].map { |path| path.to_s.sub(BACKSLASH, '') }.join(BACKSLASH)
   end
 end
+
+require_relative 'logger/railtie' if defined?(Rails)

data/lib/grape/middleware/logger/railtie.rb

@@ -0,0 +1,6 @@
+class Grape::Middleware::Logger::Railtie < Rails::Railtie
+  initializer 'grape.middleware.logger', after: :load_config_initializers do
+    Grape::Middleware::Logger.logger = Rails.application.config.logger || Rails.logger.presence
+    Grape::Middleware::Logger.filter = ActionDispatch::Http::ParameterFilter.new Rails.application.config.filter_parameters
+  end
+end

data/spec/fixtures/rails_app.rb

@@ -0,0 +1,6 @@
+class RailsApp < Rails::Application
+  RailsLogger = Class.new Logger
+  config.logger = RailsLogger.new(Tempfile.new '')
+  config.filter_parameters += [:password]
+  config.eager_load = false
+end

data/spec/integration/lib/grape/middleware/logger_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'grape/middleware/logger'
 
 describe Grape::Middleware::Logger, type: :integration do
   let(:app) { build :app }
@@ -17,7 +16,7 @@ describe Grape::Middleware::Logger, type: :integration do
     expect(subject.logger).to receive(:info).with %Q(Started POST "/api/1.0/users" at #{subject.start_time})
     expect(subject.logger).to receive(:info).with %Q(Processing by TestAPI#users)
     expect(subject.logger).to receive(:info).with %Q(  Parameters: {"id"=>"101001", "name"=>"foo", "password"=>"[FILTERED]"})
-    expect(subject.logger).to receive(:info).with /Completed 200 in \d.\d+ms/
+    expect(subject.logger).to receive(:info).with /Completed 200 in \d+.\d+ms/
     expect(subject.logger).to receive(:info).with ''
     subject.call!(env)
   end
@@ -28,15 +27,15 @@ describe Grape::Middleware::Logger, type: :integration do
     context 'namespacing' do
       let(:grape_endpoint) { build(:namespaced_endpoint) }
 
-      it 'designates the namespace with a slash' do
-        expect(subject.processed_by).to eq 'TestAPI/admin#users'
+      it 'ignores the namespacing' do
+        expect(subject.processed_by).to eq 'TestAPI#users'
       end
 
       context 'with more complex route' do
         let(:grape_endpoint) { build(:namespaced_endpoint, :complex) }
 
         it 'only escapes the first slash and leaves the rest of the untouched' do
-          expect(subject.processed_by).to eq 'TestAPI/admin#users/:name/profile'
+          expect(subject.processed_by).to eq 'TestAPI#users/:name/profile'
         end
       end
     end
@@ -49,4 +48,5 @@ describe Grape::Middleware::Logger, type: :integration do
       end
     end
   end
+
 end

data/spec/integration_rails/lib/grape/middleware/logger_spec.rb

@@ -0,0 +1,82 @@
+require 'rails_helper'
+
+describe Grape::Middleware::Logger, type: :rails_integration do
+  let(:app) { build :app }
+  let(:options) { {} }
+
+  subject { described_class.new(app, options) }
+
+  let(:app_response) { build :app_response }
+  let(:grape_request) { build :grape_request }
+  let(:grape_endpoint) { build(:grape_endpoint) }
+  let(:env) { build(:expected_env, grape_endpoint: grape_endpoint) }
+
+  describe '#logger' do
+    context 'when @options[:logger] is nil' do
+      context 'when Rails.application.config.logger is defined' do
+        it 'uses the Rails logger' do
+          expect(subject.logger).to be_present
+          expect(subject.logger).to be Rails.application.config.logger
+          expect(subject.logger.formatter).to be_nil
+        end
+      end
+
+      context 'when the class logger is nil' do
+        before { described_class.logger = nil }
+
+        it 'uses the default logger' do
+          expect(subject.logger).to be_present
+          expect(subject.logger).to_not be Rails.application.config.logger
+          expect(subject.logger).to be_a(Logger)
+          expect(subject.logger.formatter.call('foo')).to eq "foo\n"
+        end
+      end
+    end
+
+    context 'when @options[:logger] is set' do
+      let(:options) { { logger: Object.new } }
+
+      it 'returns the logger object' do
+        expect(subject.logger).to eq options[:logger]
+      end
+    end
+  end
+
+  it 'logs all parts of the request' do
+    expect(subject.logger).to receive(:info).with ''
+    expect(subject.logger).to receive(:info).with %Q(Started POST "/api/1.0/users" at #{subject.start_time})
+    expect(subject.logger).to receive(:info).with %Q(Processing by TestAPI#users)
+    expect(subject.logger).to receive(:info).with %Q(  Parameters: {"id"=>"101001", "name"=>"foo", "password"=>"[FILTERED]"})
+    expect(subject.logger).to receive(:info).with /Completed 200 in \d+.\d+ms/
+    expect(subject.logger).to receive(:info).with ''
+    subject.call!(env)
+  end
+
+  describe 'the "processing by" section' do
+    before { subject.call!(env) }
+
+    context 'namespacing' do
+      let(:grape_endpoint) { build(:namespaced_endpoint) }
+
+      it 'ignores the namespacing' do
+        expect(subject.processed_by).to eq 'TestAPI#users'
+      end
+
+      context 'with more complex route' do
+        let(:grape_endpoint) { build(:namespaced_endpoint, :complex) }
+
+        it 'only escapes the first slash and leaves the rest of the untouched' do
+          expect(subject.processed_by).to eq 'TestAPI#users/:name/profile'
+        end
+      end
+    end
+
+    context 'with more complex route' do
+      let(:grape_endpoint) { build(:grape_endpoint, :complex) }
+
+      it 'only escapes the first slash and leaves the rest of the untouched' do
+        expect(subject.processed_by).to eq 'TestAPI#users/:name/profile'
+      end
+    end
+  end
+end

data/spec/lib/grape/middleware/logger_spec.rb

@@ -99,52 +99,4 @@ describe Grape::Middleware::Logger do
       end
     end
   end
-
-  describe '#logger' do
-    context 'when @options[:logger] is nil' do
-      let(:options) { {} }
-
-      context 'when Rails is defined' do
-        before do
-          module Rails
-            class << self
-              attr_accessor :logger
-            end
-          end
-        end
-
-        it 'defaults to the the standard Logger' do
-          expect(subject.logger).to be_a(Logger)
-        end
-
-        it 'logs each message in the correct format' do
-          expect(subject.logger.formatter.call('foo')).to eq "foo\n"
-        end
-
-        context 'when Rails.logger is defined' do
-          before do
-            Rails.logger = double('rails_logger')
-          end
-
-          it 'sets @logger to Rails.logger' do
-            expect(subject.logger).to be Rails.logger
-          end
-
-          after do
-            Rails.logger = nil
-          end
-        end
-
-        after do
-          Object.send :remove_const, :Rails
-        end
-      end
-    end
-
-    context 'when @options[:logger] is set' do
-      it 'returns the logger object' do
-        expect(subject.logger).to eq options[:logger]
-      end
-    end
-  end
 end

data/spec/rails_helper.rb

@@ -0,0 +1,4 @@
+require 'rails'
+require_relative 'fixtures/rails_app'
+require 'spec_helper'
+RailsApp.initialize!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-middleware-logger
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.0
 platform: ruby
 authors:
 - Ryan Buckley
@@ -81,7 +81,8 @@ dependencies:
 description: Logging middleware for the Grape framework, similar to what Rails offers
 email:
 - arebuckley@gmail.com
-executables: []
+executables:
+- test
 extensions: []
 extra_rdoc_files: []
 files:
@@ -91,11 +92,16 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/test
 - grape-middleware-logger.gemspec
 - lib/grape/middleware/logger.rb
+- lib/grape/middleware/logger/railtie.rb
 - spec/factories.rb
+- spec/fixtures/rails_app.rb
 - spec/integration/lib/grape/middleware/logger_spec.rb
+- spec/integration_rails/lib/grape/middleware/logger_spec.rb
 - spec/lib/grape/middleware/logger_spec.rb
+- spec/rails_helper.rb
 - spec/spec_helper.rb
 homepage: https://github.com/ridiculous/grape-middleware-logger
 licenses:
@@ -123,6 +129,9 @@ specification_version: 4
 summary: A logger for the Grape framework
 test_files:
 - spec/factories.rb
+- spec/fixtures/rails_app.rb
 - spec/integration/lib/grape/middleware/logger_spec.rb
+- spec/integration_rails/lib/grape/middleware/logger_spec.rb
 - spec/lib/grape/middleware/logger_spec.rb
+- spec/rails_helper.rb
 - spec/spec_helper.rb