grape-middleware-logger 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34d9661cdf4110b925306cef1ca08daa1de0984b
-  data.tar.gz: 30a697f95684f81f84a1ab8d99b91d90730dd3ab
+  metadata.gz: 447cca99bc2e0253d2fe3645706122cec1c0c7bf
+  data.tar.gz: 83811830d95ab958323aa6cddabf0c77285f6a57
 SHA512:
-  metadata.gz: 0efea695b1be2caaf8bc63b104abc6a57240b7504d2a05bf5d15449b925feb96a5c2bcb02764979889e320391de53336af8ecfd5f107ded7663e3efccd1203ff
-  data.tar.gz: c2ab1a0ee0cb763d903b4a7b54a8f9368e8b2ab0b326a68a8d905cdfc873b9aced8239487b9abbcf2c697d7cb6289927ce33b8ac255d41570b2a9ef9fad27d67
+  metadata.gz: efb31508ea71c6901cf2e327c9a4448d577c0246dbed6e063655195f85533eb4aec0f72bb69a2d55c8b455a7a11c47040856eb1707445432c796a88e7ee14fbf
+  data.tar.gz: 6075453808d8cf7ee6e7988292315083f2dc1bda0eb77810b1d3e371bcb8843aeb46200fbe4e44d0649f380046945263cd06acaea40f08c5c5464e44388630b7

data/README.md

@@ -16,29 +16,29 @@ Logs:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'grape', '>= 0.14.0'
+gem 'grape', '>= 0.17'
 gem 'grape-middleware-logger'
 ```
 
 ## Usage
 ```ruby
 class API < Grape::API
-  # @note Make sure this above you're first +mount+
-  use Grape::Middleware::Logger
+  # @note Make sure this is above you're first +mount+
+  insert_after Grape::Middleware::Formatter, Grape::Middleware::Logger
 end
 ```
 
 Server requests will be logged to STDOUT by default.
 
 ## Example output
-Get
+GET
 ```
 Started GET "/v1/reports/101" at 2015-12-11 15:40:51 -0800
 Processing by ReportsAPI/reports/:id
   Parameters: {"id"=>"101"}
 Completed 200 in 6.29ms
 ```
-Error
+POST
 ```
 Started POST "/v1/reports" at 2015-12-11 15:42:33 -0800
 Processing by ReportsAPI/reports
@@ -54,17 +54,26 @@ The middleware logger can be customized with the following options:
 * The `:logger` option can be any object that responds to `.info(String)`
 * The `:filter` option can be any object that responds to `.filter(Hash)` and returns a hash.
 
+For example:
+
+```ruby
+insert_after Grape::Middleware::Formatter, Grape::Middleware::Logger, {
+  logger: Logger.new(STDERR),
+  filter: Class.new { def filter(opts) opts.reject { |k, _| k.to_s == 'password' } end }.new
+}
+```
+
 ## Using Rails?
 `Rails.logger` and `Rails.application.config.filter_parameters` will be used automatically as the default logger and 
-param filterer, respectively.
+param filterer, respectively. This behavior can be overridden by passing the `:logger` or
+`:filter` option when mounting.
 
 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.middleware.swap 'Rails::Rack::Logger', 'SelectiveLogger'
 
 # config/initializers/selective_logger.rb
 class SelectiveLogger

data/grape-middleware-logger.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'grape-middleware-logger'
-  spec.version       = '1.6.0'
+  spec.version       = '1.7.0'
   spec.platform      = Gem::Platform::RUBY
   spec.authors       = ['Ryan Buckley']
   spec.email         = ['arebuckley@gmail.com']
@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'grape', '>= 0.14', '< 1'
+  spec.add_dependency 'grape', '>= 0.17', '< 1'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'mime-types', '~> 2'

data/lib/grape/middleware/logger.rb

@@ -7,7 +7,7 @@ class Grape::Middleware::Logger < Grape::Middleware::Globals
   attr_reader :logger
 
   class << self
-    attr_accessor :logger, :filter, :on_parameters
+    attr_accessor :logger, :filter
 
     def default_logger
       default = Logger.new(STDOUT)
@@ -82,10 +82,6 @@ class Grape::Middleware::Logger < Grape::Middleware::Globals
 
   def parameters
     request_params = env[Grape::Env::GRAPE_REQUEST_PARAMS].to_hash
-    formatter = Grape::Middleware::Formatter.new(app)
-    formatter.instance_variable_set :@env, env
-    # @note parses and assigns params to @env[Grape::Env::RACK_REQUEST_FORM_HASH]
-    formatter.before
     request_params.merge! env[Grape::Env::RACK_REQUEST_FORM_HASH] if env[Grape::Env::RACK_REQUEST_FORM_HASH]
     request_params.merge! env['action_dispatch.request.request_parameters'] if env['action_dispatch.request.request_parameters']
     if @options[:filter]
@@ -112,12 +108,4 @@ class Grape::Middleware::Logger < Grape::Middleware::Globals
   end
 end
 
-# @description Override formatter #before so we don't read and parse the env['rack.input'] value twice
-Grape::Middleware::Formatter.send :define_method, :before do
-  negotiate_content_type
-  read_body_input unless env.key? Grape::Env::RACK_REQUEST_FORM_HASH
-end
-
-if defined?(Rails)
-  require_relative 'logger/railtie'
-end
+require_relative 'logger/railtie' if defined?(Rails)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-middleware-logger
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Ryan Buckley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-04 00:00:00.000000000 Z
+date: 2016-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.17'
     - - "<"
       - !ruby/object:Gem::Version
         version: '1'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.17'
     - - "<"
       - !ruby/object:Gem::Version
         version: '1'
@@ -147,3 +147,4 @@ test_files:
 - spec/lib/grape/middleware/logger_spec.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb
+has_rdoc: