grape-middleware-logger 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 590ce26a5ad8498e9a23d0d04fb67d145839c3d2
-  data.tar.gz: 3b14c745464c253f07dc3f1d3114670ef69498f4
+  metadata.gz: 5c6903ab2693fd8f2192bcdf3a3d56353cb5954b
+  data.tar.gz: bf21e7e9fe1d0730288c412e88ac1c011238316d
 SHA512:
-  metadata.gz: 52bbc22b98b568a93abca85bb5037d5c01d21e791d15ed484ea8f03a3a895d15f6a251fd02bbe33d64b0b507db8850a07e52cb8c1244ae162fff67ef2328b94f
-  data.tar.gz: 2f7471095ee5ac2a94e9f98ca55e23d6656d6ff84126eb3860998b909484442e5adc97eb8b18217880cd10a4c849b7a14c72d68a85750751670f8ed8e51413bb
+  metadata.gz: e2682ddacc69dbd6f7300b12d29f05e0350bb0d4b33b4bab108f46abe0b14d652a1f6963a141a9cb31cbdfd11eee4c5e4867af5e088449e5a3df4bc829a70466
+  data.tar.gz: d6b82afc9f5f2e2adb7a41eaa1ea81363aefd54da2dbaef4d4bb5b30c7411e7f8cbeedf62e7402719bbd8f4940b34e14bd8388d3db673d4dd32630224f9d1633

data/Gemfile

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

data/README.md

@@ -9,13 +9,14 @@ Simple logger for Grape apps. Logs request path, parameters, status and time tak
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'grape', '>= 0.12.0'
+gem 'grape', '>= 0.14.0'
 gem 'grape-middleware-logger'
 ```
 
 ## Usage
 ```ruby
 class API < Grape::API
+  # @note Make sure this above you're first +mount+
   use Grape::Middleware::Logger
 end
 ```
@@ -41,17 +42,23 @@ The `filter` option can be any object that responds to `.filter(params_hash)`
 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
 ```
 Started POST "/v1/reports" at 2015-12-11 15:42:33 -0800
+Processing by ReportsAPI#reports
   Parameters: {"name"=>"foo", "password"=>"[FILTERED]"}
   Error: {:error=>"undefined something something bad", :detail=>"Whoops"}
 Completed 422 in 6.29ms
 ```
 
+## Rack
+
+If you're using the `rackup` command to run your server in development, pass the `-q` flag to silence the default rack logger.
+
 ## Credits
 
 Big thanks to jadent's question/answer on [stackoverflow](http://stackoverflow.com/questions/25048163/grape-using-error-and-grapemiddleware-after-callback)

data/grape-middleware-logger.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'grape-middleware-logger'
-  spec.version       = '1.3.0'
+  spec.version       = '1.4.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.12', '< 1'
+  spec.add_dependency 'grape', '>= 0.14', '< 1'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'

data/lib/grape/middleware/logger.rb

@@ -8,7 +8,7 @@ class Grape::Middleware::Logger < Grape::Middleware::Globals
     super
     @logger = options[:logger]
     @logger ||= Rails.logger if defined?(Rails) && Rails.logger.present?
-    @logger ||= Logger.new(STDOUT)
+    @logger ||= default_logger
   end
 
   def before
@@ -16,10 +16,11 @@ class Grape::Middleware::Logger < Grape::Middleware::Globals
     super # sets env['grape.*']
     logger.info ''
     logger.info %Q(Started %s "%s" at %s) % [
-      env['grape.request'].request_method,
-      env['grape.request'].path,
+      env[Grape::Env::GRAPE_REQUEST].request_method,
+      env[Grape::Env::GRAPE_REQUEST].path,
       start_time.to_s
     ]
+    logger.info %Q(Processing by #{processed_by})
     logger.info %Q(  Parameters: #{parameters})
   end
 
@@ -73,7 +74,7 @@ class Grape::Middleware::Logger < Grape::Middleware::Globals
   end
 
   def parameters
-    request_params = env['grape.request.params'].to_hash
+    request_params = env[Grape::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)
@@ -85,4 +86,24 @@ class Grape::Middleware::Logger < Grape::Middleware::Globals
   def start_time
     @start_time ||= Time.now
   end
+
+  def processed_by
+    endpoint = env[Grape::Env::API_ENDPOINT]
+    parts = endpoint.options[:for].to_s
+    parts << endpoint.namespace if endpoint.namespace != '/'
+    parts << '#' << endpoint.options[:path].map { |path| path.to_s.sub('/', '') }.join('/')
+    parts
+  end
+
+  def default_logger
+    default = Logger.new(STDOUT)
+    default.formatter = LogFormatter.new
+    default
+  end
+
+  class LogFormatter
+    def call(*args)
+      args.last.to_s << "\n"
+    end
+  end
 end

data/spec/factories.rb

@@ -0,0 +1,90 @@
+FactoryGirl.define do
+  class ExpectedEnv < Hash
+    attr_accessor :grape_request, :params, :post_params, :grape_endpoint
+  end
+
+  class ParamFilter
+    def filter(opts)
+      opts.each_pair { |key, val| val[0..-1] = '[FILTERED]' if key == 'password' }
+    end
+  end
+
+  class TestAPI
+  end
+
+  class App
+    attr_accessor :response
+
+    def call(_env)
+      response
+    end
+  end
+
+  factory :param_filter
+
+  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) }
+
+    initialize_with do
+      new.merge(
+        'REQUEST_METHOD' => 'POST',
+        'PATH_INFO' => '/api/1.0/users',
+        'action_dispatch.request.request_parameters' => post_params,
+        Grape::Env::GRAPE_REQUEST => grape_request,
+        Grape::Env::GRAPE_REQUEST_PARAMS => params,
+        Grape::Env::API_ENDPOINT => grape_endpoint
+      )
+    end
+  end
+
+  factory :grape_endpoint, class: Grape::Endpoint do
+    settings { Grape::Util::InheritableSetting.new }
+    options {
+      {
+        path: [:users],
+        method: 'get',
+        for: TestAPI
+      }
+    }
+
+    initialize_with { new(settings, options) }
+
+    trait :complex do
+      options {
+        {
+          path: ['/users/:name/profile'],
+          method: 'put',
+          for: TestAPI
+        }
+      }
+    end
+  end
+
+  factory :namespaced_endpoint, parent: :grape_endpoint do
+    initialize_with do
+      new(settings, options).tap do |me|
+        me.namespace_stackable(:namespace, Grape::Namespace.new('/admin', {}))
+      end
+    end
+  end
+
+  factory :app_response, class: Rack::Response do
+    initialize_with { new('Hello World', 200, {}) }
+  end
+
+  factory :grape_request, class: OpenStruct do
+    initialize_with {
+      new(request_method: 'POST', path: '/api/1.0/users', headers: {}, params: { 'id' => '101001' })
+    }
+  end
+
+  factory :app do
+    response { build :app_response }
+  end
+
+end

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

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'grape/middleware/logger'
+
+describe Grape::Middleware::Logger, type: :integration do
+  let(:app) { build :app }
+  let(:options) { { filter: build(:param_filter), logger: Logger.new(Tempfile.new('logger')) } }
+
+  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) }
+
+  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 'designates the namespace with a slash' do
+        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/admin#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

@@ -1,25 +1,14 @@
 require 'spec_helper'
-require 'grape/middleware/logger'
 
 describe Grape::Middleware::Logger do
   let(:app) { double('app') }
-  let(:options) { { filter: ParamFilter.new, logger: Object.new } }
+  let(:options) { { filter: build(:param_filter), logger: Object.new } }
 
   subject { described_class.new(app, options) }
 
-  let(:app_response) { Rack::Response.new 'Hello World', 200, {} }
-  let(:grape_request) { OpenStruct.new(request_method: 'POST', path: '/api/1.0/users', headers: {}, params: { 'id' => '101001' }) }
-  let(:env) {
-    {
-      'grape.request' => grape_request,
-      'grape.request.params' => grape_request.params,
-      'action_dispatch.request.request_parameters' => {
-        'name' => 'foo',
-        'password' => 'access'
-      },
-      'rack.input' => OpenStruct.new
-    }
-  }
+  let(:app_response) { build :app_response }
+  let(:grape_request) { build :grape_request }
+  let(:env) { build(:expected_env) }
 
   describe '#call!' do
     context 'when calling the app results in an error response' do
@@ -128,6 +117,10 @@ describe Grape::Middleware::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')
@@ -154,26 +147,4 @@ describe Grape::Middleware::Logger do
       end
     end
   end
-
-  describe 'integration' do
-    it 'properly logs requests' do
-      expect(app).to receive(:call).with(env).and_return(app_response)
-      expect(Grape::Request).to receive(:new).and_return(grape_request)
-      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(  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
-  end
-
-  #
-  # Test class
-  #
-  class ParamFilter
-    def filter(opts)
-      opts.each_pair { |key, val| val[0..-1] = '[FILTERED]' if key == 'password' }
-    end
-  end
 end

data/spec/spec_helper.rb

@@ -2,7 +2,12 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'ostruct'
+require 'factory_girl'
+require 'grape/middleware/logger'
+
+FactoryGirl.find_definitions
 
 RSpec.configure do |config|
   config.raise_errors_for_deprecations!
+  config.include FactoryGirl::Syntax::Methods
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-middleware-logger
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Ryan Buckley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-11 00:00:00.000000000 Z
+date: 2015-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.14'
     - - "<"
       - !ruby/object:Gem::Version
         version: '1'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.14'
     - - "<"
       - !ruby/object:Gem::Version
         version: '1'
@@ -93,6 +93,8 @@ files:
 - Rakefile
 - grape-middleware-logger.gemspec
 - lib/grape/middleware/logger.rb
+- spec/factories.rb
+- spec/integration/lib/grape/middleware/logger_spec.rb
 - spec/lib/grape/middleware/logger_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -120,5 +122,7 @@ signing_key:
 specification_version: 4
 summary: A logger for the Grape framework
 test_files:
+- spec/factories.rb
+- spec/integration/lib/grape/middleware/logger_spec.rb
 - spec/lib/grape/middleware/logger_spec.rb
 - spec/spec_helper.rb