grape-middleware-logger 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efcf5674de9e8fcbcce7aebfda90fa8231e35475
-  data.tar.gz: 856cc2ebb17f174185c02103200457da79841acc
+  metadata.gz: 34d9661cdf4110b925306cef1ca08daa1de0984b
+  data.tar.gz: 30a697f95684f81f84a1ab8d99b91d90730dd3ab
 SHA512:
-  metadata.gz: 98ad10db03c07d57c1264d06fbb3cb54ab312746998873ae1e0b3aa9c73d7e503ca2a5d252d78a5d685bc08f75819c80c8b0a2192541e53b97db083b483b6df8
-  data.tar.gz: 0e1975f5d77664c5cfa05d73d74d45fbf4c4daab48af8c2de17eff7ca51c1744933ff3048121537cb978476cb6dfc1029202fcd982d1b957a5399243c0374ad2
+  metadata.gz: 0efea695b1be2caaf8bc63b104abc6a57240b7504d2a05bf5d15449b925feb96a5c2bcb02764979889e320391de53336af8ecfd5f107ded7663e3efccd1203ff
+  data.tar.gz: c2ab1a0ee0cb763d903b4a7b54a8f9368e8b2ab0b326a68a8d905cdfc873b9aced8239487b9abbcf2c697d7cb6289927ce33b8ac255d41570b2a9ef9fad27d67

data/.travis.yml

@@ -1,9 +1,9 @@
 language: ruby
 rvm:
   - 1.9.3
-  - 2.2.1
-  - 2.2.2
-  - 2.2.3
-before_install: gem install bundler -v 1.10.5
-script:
-  - bin/test
+  - 2.1.5
+  - 2.2.4
+  - 2.3.0
+before_install:
+  - gem install bundler -v 1.10.5
+  - gem install mime-types -v 2.6.2

data/README.md

@@ -1,8 +1,15 @@
-# Grape::Middleware::Logger
+# A logger for Grape apps
 [![Code Climate](https://codeclimate.com/github/ridiculous/grape-middleware-logger/badges/gpa.svg)](https://codeclimate.com/github/ridiculous/grape-middleware-logger) [![Gem Version](https://badge.fury.io/rb/grape-middleware-logger.svg)](http://badge.fury.io/rb/grape-middleware-logger)
 [![Build Status](https://travis-ci.org/ridiculous/grape-middleware-logger.svg)](https://travis-ci.org/ridiculous/grape-middleware-logger)
 
-Simple logger for Grape apps. Logs request path, parameters, status and time taken. Also logs exceptions and error responses (thrown by `error!`).
+Logs:
+  * Request path
+  * Parameters
+  * Endpoint class name and handler
+  * Response status
+  * Duration of the request
+  * Exceptions
+  * Error responses from `error!`
 
 ## Installation
 
@@ -23,35 +30,30 @@ end
 
 Server requests will be logged to STDOUT by default.
 
-## 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: CustomFilter.new
-}
-```
-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)`
-
 ## Example output
 Get
 ```
 Started GET "/v1/reports/101" at 2015-12-11 15:40:51 -0800
-Processing by ReportsAPI#reports/:id
+Processing by ReportsAPI/reports/:id
   Parameters: {"id"=>"101"}
 Completed 200 in 6.29ms
 ```
 Error
 ```
 Started POST "/v1/reports" at 2015-12-11 15:42:33 -0800
-Processing by ReportsAPI#reports
+Processing by ReportsAPI/reports
   Parameters: {"name"=>"foo", "password"=>"[FILTERED]"}
   Error: {:error=>"undefined something something bad", :detail=>"Whoops"}
 Completed 422 in 6.29ms
 ```
 
+## Customization
+
+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.
+
 ## Using Rails?
 `Rails.logger` and `Rails.application.config.filter_parameters` will be used automatically as the default logger and 
 param filterer, respectively.
@@ -93,7 +95,6 @@ and would love to see these two consolidated at some point.
 ## Contributing
 
 1. Fork it ( https://github.com/ridiculous/grape-middleware-logger/fork )
-1. Run the test suite with `bin/test`
 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`)

data/Rakefile

@@ -1,3 +1,15 @@
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-task default: :spec
+
+RSpec::Core::RakeTask.new(:spec) do |config|
+  config.pattern = 'spec/lib/**/*_spec.rb'
+end
+
+RSpec::Core::RakeTask.new(:integration) do |config|
+  config.pattern = 'spec/integration/**/*_spec.rb'
+end
+
+RSpec::Core::RakeTask.new(:integration_rails) do |config|
+  config.pattern = 'spec/integration_rails/**/*_spec.rb'
+end
+
+task default: [:spec, :integration, :integration_rails]

data/grape-middleware-logger.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'grape-middleware-logger'
-  spec.version       = '1.5.1'
+  spec.version       = '1.6.0'
   spec.platform      = Gem::Platform::RUBY
   spec.authors       = ['Ryan Buckley']
   spec.email         = ['arebuckley@gmail.com']
@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'grape', '>= 0.14', '< 1'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'mime-types', '~> 2'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '>= 3.2', '< 4'
 end

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
+    attr_accessor :logger, :filter, :on_parameters
 
     def default_logger
       default = Logger.new(STDOUT)
@@ -82,7 +82,12 @@ class Grape::Middleware::Logger < Grape::Middleware::Globals
 
   def parameters
     request_params = env[Grape::Env::GRAPE_REQUEST_PARAMS].to_hash
-    request_params.merge!(env['action_dispatch.request.request_parameters'.freeze] || {}) # for Rails
+    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]
       @options[:filter].filter(request_params)
     else
@@ -96,8 +101,23 @@ class Grape::Middleware::Logger < Grape::Middleware::Globals
 
   def processed_by
     endpoint = env[Grape::Env::API_ENDPOINT]
-    endpoint.options[:for].to_s << '#'.freeze << endpoint.options[:path].map { |path| path.to_s.sub(BACKSLASH, '') }.join(BACKSLASH)
+    result = []
+    if endpoint.namespace == BACKSLASH
+      result << ''
+    else
+      result << endpoint.namespace
+    end
+    result.concat endpoint.options[:path].map { |path| path.to_s.sub(BACKSLASH, '') }
+    endpoint.options[:for].to_s << result.join(BACKSLASH)
   end
 end
 
-require_relative 'logger/railtie' if defined?(Rails)
+# @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

data/spec/factories.rb

@@ -1,11 +1,13 @@
 FactoryGirl.define do
   class ExpectedEnv < Hash
-    attr_accessor :grape_request, :params, :post_params, :grape_endpoint
+    attr_accessor :grape_request, :params, :post_params, :rails_post_params, :grape_endpoint
   end
 
   class ParamFilter
+    attr_accessor :list
+
     def filter(opts)
-      opts.each_pair { |key, val| val[0..-1] = '[FILTERED]' if key == 'password' }
+      opts.each_pair { |key, val| val[0..-1] = '[FILTERED]' if list.include?(key) }
     end
   end
 
@@ -20,23 +22,27 @@ FactoryGirl.define do
     end
   end
 
-  factory :param_filter
+  factory :param_filter do
+    list %w[password secret]
+  end
 
   require 'rack/rewindable_input'
 
   factory :expected_env do
     grape_request { build :grape_request }
-    params { grape_request.params }
-    post_params { { 'name' => 'foo', 'password' => 'access' } }
     grape_endpoint { build(:grape_endpoint) }
+    params { grape_request.params }
+    post_params { { 'secret' => 'key', 'customer' => [] } }
+    rails_post_params { { 'name' => 'foo', 'password' => 'access' } }
 
     initialize_with do
       new.merge(
         'REQUEST_METHOD' => 'POST',
         'PATH_INFO' => '/api/1.0/users',
-        'action_dispatch.request.request_parameters' => post_params,
+        'action_dispatch.request.request_parameters' => rails_post_params,
         Grape::Env::GRAPE_REQUEST => grape_request,
         Grape::Env::GRAPE_REQUEST_PARAMS => params,
+        Grape::Env::RACK_REQUEST_FORM_HASH => post_params,
         Grape::Env::API_ENDPOINT => grape_endpoint
       )
     end

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

@@ -14,8 +14,8 @@ describe Grape::Middleware::Logger, type: :integration do
   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 %Q(Processing by TestAPI/users)
+    expect(subject.logger).to receive(:info).with %Q(  Parameters: {"id"=>"101001", "secret"=>"[FILTERED]", "customer"=>[], "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)
@@ -28,14 +28,14 @@ describe Grape::Middleware::Logger, type: :integration do
       let(:grape_endpoint) { build(:namespaced_endpoint) }
 
       it 'ignores the namespacing' do
-        expect(subject.processed_by).to eq 'TestAPI#users'
+        expect(subject.processed_by).to eq 'TestAPI/admin/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'
+          expect(subject.processed_by).to eq 'TestAPI/admin/users/:name/profile'
         end
       end
     end
@@ -44,7 +44,7 @@ describe Grape::Middleware::Logger, type: :integration 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'
+        expect(subject.processed_by).to eq 'TestAPI/users/:name/profile'
       end
     end
   end

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

@@ -45,8 +45,8 @@ describe Grape::Middleware::Logger, type: :rails_integration do
   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 %Q(Processing by TestAPI/users)
+    expect(subject.logger).to receive(:info).with %Q(  Parameters: {"id"=>"101001", "secret"=>"key", "customer"=>[], "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)
@@ -59,14 +59,14 @@ describe Grape::Middleware::Logger, type: :rails_integration do
       let(:grape_endpoint) { build(:namespaced_endpoint) }
 
       it 'ignores the namespacing' do
-        expect(subject.processed_by).to eq 'TestAPI#users'
+        expect(subject.processed_by).to eq 'TestAPI/admin/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'
+          expect(subject.processed_by).to eq 'TestAPI/admin/users/:name/profile'
         end
       end
     end
@@ -75,7 +75,7 @@ describe Grape::Middleware::Logger, type: :rails_integration 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'
+        expect(subject.processed_by).to eq 'TestAPI/users/:name/profile'
       end
     end
   end

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

@@ -8,7 +8,7 @@ describe Grape::Middleware::Logger do
 
   let(:app_response) { build :app_response }
   let(:grape_request) { build :grape_request }
-  let(:env) { build(:expected_env) }
+  let(:env) { build :expected_env }
 
   describe '#call!' do
     context 'when calling the app results in an error response' do
@@ -82,12 +82,12 @@ describe Grape::Middleware::Logger do
 
     context 'when @options[:filter] is set' do
       it 'calls +filter+ with the raw parameters' do
-        expect(subject.options[:filter]).to receive(:filter).with({ "id" => '101001', "name" => "foo", "password" => "access" })
+        expect(subject.options[:filter]).to receive(:filter).with({ "id" => '101001', "secret" => "key", "customer" => [], "name"=>"foo", "password"=>"access" })
         subject.parameters
       end
 
       it 'returns the filtered results' do
-        expect(subject.parameters).to eq({ "id" => '101001', "name" => "foo", "password" => "[FILTERED]" })
+        expect(subject.parameters).to eq({ "id" => '101001', "secret" => "[FILTERED]", "customer" => [], "name"=>"foo", "password"=>"[FILTERED]" })
       end
     end
 
@@ -95,7 +95,7 @@ describe Grape::Middleware::Logger do
       let(:options) { {} }
 
       it 'returns the params extracted out of @env' do
-        expect(subject.parameters).to eq({ "id" => '101001', "name" => "foo", "password" => "access" })
+        expect(subject.parameters).to eq({ "id" => '101001', "secret" => "key", "customer" => [], "name"=>"foo", "password"=>"access" })
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-middleware-logger
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Ryan Buckley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-15 00:00:00.000000000 Z
+date: 2016-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -44,6 +44,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -81,8 +95,7 @@ dependencies:
 description: Logging middleware for the Grape framework, similar to what Rails offers
 email:
 - arebuckley@gmail.com
-executables:
-- test
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -92,7 +105,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/test
 - grape-middleware-logger.gemspec
 - lib/grape/middleware/logger.rb
 - lib/grape/middleware/logger/railtie.rb

data/bin/test

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