grape-middleware-logger 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4547077b8d2d510b968f5929a6a5a363dd923c96
-  data.tar.gz: d0ef665c52d56e8381b258e3dea232c20e53bd6c
+  metadata.gz: bdd1d91790c08e781a650d7a86940ff36b134b34
+  data.tar.gz: 5ba7043cfc03c3f7f895069ae3d1c63d3a89e6ef
 SHA512:
-  metadata.gz: 3fe36c90107dfd40ed7b52c145a68646c0ccfbc5b5833cdc16c6318f13016def891f4935f7b4e4bde2ef93fad89fb469c4f89e1e79a1e901ddec3cc817e3bf74
-  data.tar.gz: 9e158043f094a7c41eb3e7721d25c6487f0f1538587b5508150d9a920d85dc7743c30481348977ff51b99f4db206d66662c2f93e77efd21cc43b3cc5729e4f54
+  metadata.gz: ee6e3ed6f1f736358989522e1fe4f0ef66e60d2d35a30c5ae54eb073738db8ef1868b07ef76f6b583a9c36268946f4fc576d11709c81dc46d05aee5dde78a0f4
+  data.tar.gz: b365b76db8fcdbbf47f1cf871501bfc7f160d24747bc581bdae2651c13cc6befce54a9d55733cf129bbca32a9f0ab2628a754bfa9afed12b04e913a36c9303d1

data/README.md

@@ -17,14 +17,22 @@ gem 'grape-middleware-logger'
 class API < Grape::API
   use Grape::Middleware::Logger
 end
-```    
-Using Grape with Rails or want to customize the logging? You can provide a `logger` option, which just has to respond to `.info(msg)`. Example Rails logging and parameter sanitization:
+```
+
+#### Rails
+Using Grape with Rails? `Rails.logger` will be used by default.
+
+#### Custom setup
+Want to customize the logging? You can provide a `logger` option.
+
+Example using a CustomLogger and parameter sanitization:
 ```ruby
-use Grape::Middleware::Logger, { 
-  logger: Rails.logger, 
+use Grape::Middleware::Logger, {
+  logger: CustomLogger.new,
   filter: ActionDispatch::Http::ParameterFilter.new(Rails.application.config.filter_parameters)
 }
 ```
+The `logger` option can be any object that responds to `.info(msg)`
 
 The `filter` option can be any object that responds to `.filter(params_hash)`
 

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

@@ -1,7 +1,7 @@
 module Grape
   module Middleware
     class Logger
-      VERSION = '1.0.0'
+      VERSION = '1.1.0'
     end
   end
 end

data/lib/grape/middleware/logger.rb

@@ -3,79 +3,75 @@ require 'grape'
 
 # avoid superclass mismatch when version file gets loaded first
 Grape::Middleware.send :remove_const, :Logger if defined? Grape::Middleware::Logger
-module Grape
-  module Middleware
-    class Logger < Grape::Middleware::Globals
-
-      def before
-        start_time
-        super # sets env['grape.*']
-        logger.info ''
-        logger.info %Q(Started #{env['grape.request'].request_method} "#{env['grape.request'].path}")
-        logger.info %Q(  Parameters: #{parameters})
-      end
+class Grape::Middleware::Logger < Grape::Middleware::Globals
+  def before
+    start_time
+    super # sets env['grape.*']
+    logger.info ''
+    logger.info %Q(Started #{env['grape.request'].request_method} "#{env['grape.request'].path}")
+    logger.info %Q(  Parameters: #{parameters})
+  end
 
-      # @note Error and exception handling are required for the +after+ hooks
-      #   Exceptions are logged as a 500 status and re-raised
-      #   Other "errors" are caught, logged and re-thrown
-      def call!(env)
-        @env = env
-        before
-        error = catch(:error) do
-          begin
-            @app_response = @app.call(@env)
-          rescue => e
-            after_exception(e)
-            raise e
-          end
-          nil
-        end
-        if error
-          after_failure(error)
-          throw(:error, error)
-        else
-          after(@app_response.status)
-        end
-        @app_response
+  # @note Error and exception handling are required for the +after+ hooks
+  #   Exceptions are logged as a 500 status and re-raised
+  #   Other "errors" are caught, logged and re-thrown
+  def call!(env)
+    @env = env
+    before
+    error = catch(:error) do
+      begin
+        @app_response = @app.call(@env)
+      rescue => e
+        after_exception(e)
+        raise e
       end
+      nil
+    end
+    if error
+      after_failure(error)
+      throw(:error, error)
+    else
+      after(@app_response.status)
+    end
+    @app_response
+  end
 
-      def after(status)
-        logger.info "Completed #{status} in #{((Time.now - start_time) * 1000).round(2)}ms"
-        logger.info ''
-      end
+  def after(status)
+    logger.info "Completed #{status} in #{((Time.now - start_time) * 1000).round(2)}ms"
+    logger.info ''
+  end
 
-      #
-      # Helpers
-      #
+  #
+  # Helpers
+  #
 
-      def after_exception(e)
-        logger.info %Q(  Error: #{e.message})
-        after(500)
-      end
+  def after_exception(e)
+    logger.info %Q(  Error: #{e.message})
+    after(500)
+  end
 
-      def after_failure(error)
-        logger.info %Q(  Error: #{error[:message]}) if error[:message]
-        after(error[:status])
-      end
+  def after_failure(error)
+    logger.info %Q(  Error: #{error[:message]}) if error[:message]
+    after(error[:status])
+  end
 
-      def parameters
-        request_params = env['grape.request.params'].to_hash
-        request_params.merge!(env['action_dispatch.request.request_parameters'] || {}) # for Rails
-        if @options[:filter]
-          @options[:filter].filter(request_params)
-        else
-          request_params
-        end
-      end
+  def parameters
+    request_params = env['grape.request.params'].to_hash
+    request_params.merge!(env['action_dispatch.request.request_parameters'] || {}) # for Rails
+    if @options[:filter]
+      @options[:filter].filter(request_params)
+    else
+      request_params
+    end
+  end
 
-      def start_time
-        @start_time ||= Time.now
-      end
+  def start_time
+    @start_time ||= Time.now
+  end
 
-      def logger
-        @logger ||= @options[:logger] || ::Logger.new(STDOUT)
-      end
-    end
+  def logger
+    @logger ||= @options[:logger]
+    @logger ||= defined?(Rails) && Rails.logger.present? ? Rails.logger : Logger.new(STDOUT)
   end
 end
 

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

@@ -97,8 +97,24 @@ describe Grape::Middleware::Logger do
     context 'when @options[:logger] is nil' do
       let(:options) { {} }
 
-      it 'defaults to the the standard Logger' do
-        expect(subject.logger).to be_a(Logger)
+      context 'when Rails is defined' do
+        module Rails
+          class << self
+            attr_accessor :logger
+          end
+        end
+
+        it 'defaults to the the standard Logger' do
+          expect(subject.logger).to be_a(Logger)
+        end
+
+        context 'when Rails.logger is defined' do
+          before { Rails.logger = double('rails_logger') }
+
+          it 'sets @logger to Rails.logger' do
+            expect(subject.logger).to be Rails.logger
+          end
+        end
       end
     end
 
@@ -125,8 +141,7 @@ describe Grape::Middleware::Logger do
   #
   # Test class
   #
-
-  ParamFilter = Class.new do
+  class ParamFilter
     def filter(opts)
       opts.each_pair { |key, val| val[0..-1] = '[FILTERED]' if key == 'password' }
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-middleware-logger
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ryan Buckley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-11 00:00:00.000000000 Z
+date: 2015-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape