grape-middleware-logger 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9616608e69e843ba20b98bda30778c2f4792186
-  data.tar.gz: 75817806ea070bb0dcaa427ee7a2fb3b5a80756a
+  metadata.gz: 4547077b8d2d510b968f5929a6a5a363dd923c96
+  data.tar.gz: d0ef665c52d56e8381b258e3dea232c20e53bd6c
 SHA512:
-  metadata.gz: c652ab2e7596af5d282579c981711e92d348f6f43e18c4c107605b5bf03d8dffd31b049a90785377c8ef41cf4da292e278ab436fbc4ddf9db0ee2248d7687338
-  data.tar.gz: 2a02914324c3475a7e26f1e2b398adc1254dfd67edcba4c39fca01801e6a82d1190768877bd0252bc0ff3d0d55237b4ee8824c1c63235439fe627bb207576612
+  metadata.gz: 3fe36c90107dfd40ed7b52c145a68646c0ccfbc5b5833cdc16c6318f13016def891f4935f7b4e4bde2ef93fad89fb469c4f89e1e79a1e901ddec3cc817e3bf74
+  data.tar.gz: 9e158043f094a7c41eb3e7721d25c6487f0f1538587b5508150d9a920d85dc7743c30481348977ff51b99f4db206d66662c2f93e77efd21cc43b3cc5729e4f54

data/.gitignore

@@ -13,3 +13,5 @@
 *.a
 mkmf.log
 *.gem
+.ruby-version
+.ruby-gemset

data/README.md

@@ -1,36 +1,48 @@
 # Grape::Middleware::Logger
+[![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)
 
-Works if you're running directly off Grape master. Otherwise, you'll have to wait for the release of Grape v0.12.0
+Simple logger for Grape apps. Logs request path, parameters, status and time taken. Also logs exceptions and error responses (thrown by `error!`).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
+gem 'grape', '>= 0.12.0'
 gem 'grape-middleware-logger'
 ```
 
-And then execute:
-
-    $ bundle
+## Usage
+```ruby
+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:
+```ruby
+use Grape::Middleware::Logger, { 
+  logger: Rails.logger, 
+  filter: ActionDispatch::Http::ParameterFilter.new(Rails.application.config.filter_parameters)
+}
+```
 
-Or install it yourself as:
+The `filter` option can be any object that responds to `.filter(params_hash)`
 
-    $ gem install grape-middleware-logger
+## Example output
+Get
+```
+Started GET "/v1/reports/101"
+  Parameters: {"id"=>"101"}
+Completed 200 in 6.29ms
+```
+Error
+```
+Started GET "/v1/reports/101"
+  Parameters: {"id"=>"101"}
+  Error: {:error=>"undefined something something bad", :detail=>"Whoops"}
+Completed 422 in 6.29ms
+```
 
-## Usage
-    
-    class API < Grape::API
-      use Grape::Middleware::Logger
-    end
-    
-Using Grape with Rails? Add consistent logging and param filtering with
-
-    use Grape::Middleware::Logger, { 
-      logger: Rails.logger, 
-      filter: ActionDispatch::Http::ParameterFilter.new(Rails.application.config.filter_parameters)
-    }
-    
 ## 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

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.platform      = Gem::Platform::RUBY
   spec.authors       = ['Ryan Buckley']
   spec.email         = ['arebuckley@gmail.com']
-  spec.summary       = %q{Logging middleware for Grape apps}
-  spec.description   = %q{Logging middleware for Grape apps, similar to what Rails offers}
+  spec.summary       = %q{A logger for the Grape framework}
+  spec.description   = %q{Logging middleware for the Grape framework, similar to what Rails offers}
   spec.homepage      = ''
   spec.license       = 'MIT'
 
@@ -19,9 +19,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'grape'
+  spec.add_dependency 'grape', '>= 0.12', '< 1'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '>= 3.0'
+  spec.add_development_dependency 'rspec', '>= 3.2', '< 4'
 end

data/lib/grape/middleware/logger.rb

@@ -1,5 +1,5 @@
 require 'logger'
-require 'grape/middleware/globals'
+require 'grape'
 
 # avoid superclass mismatch when version file gets loaded first
 Grape::Middleware.send :remove_const, :Logger if defined? Grape::Middleware::Logger
@@ -9,21 +9,32 @@ module Grape
 
       def before
         start_time
-        super
+        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) { @app_response = @app.call(@env); nil }
+        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.first)
+          after(@app_response.status)
         end
         @app_response
       end
@@ -37,6 +48,11 @@ module Grape
       # Helpers
       #
 
+      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])
@@ -44,7 +60,7 @@ module Grape
 
       def parameters
         request_params = env['grape.request.params'].to_hash
-        request_params.merge!(env['action_dispatch.request.request_parameters'] || {})
+        request_params.merge!(env['action_dispatch.request.request_parameters'] || {}) # for Rails
         if @options[:filter]
           @options[:filter].filter(request_params)
         else

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

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

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

@@ -7,21 +7,19 @@ describe Grape::Middleware::Logger do
 
   subject { described_class.new(app, options) }
 
-  let(:app_response) { [200, {}, 'Hello World'] }
+  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' => OpenStruct.new(request_method: 'POST', path: '/api/1.0/users'),
-      'grape.request.params' => {
-        'id' => '101001'
-      },
+      'grape.request' => grape_request,
+      'grape.request.params' => grape_request.params,
       'action_dispatch.request.request_parameters' => {
         'name' => 'foo',
         'password' => 'access'
-      }
+      },
+      'rack.input' => OpenStruct.new
     }
   }
-  # @todo remove when Grape v0.12.0 is released
-  before(:each) { allow(subject).to receive(:before) }
 
   describe '#call!' do
     context 'when calling the app results in an error response' do
@@ -51,18 +49,6 @@ describe Grape::Middleware::Logger do
         expect(subject.call!(env)).to eq app_response
       end
     end
-
-    describe 'integration' do
-      it 'properly logs requests', pending: 'Grape v0.12.0' do
-        expect(app).to receive(:call).with(env).and_return(app_response)
-        expect(subject.logger).to receive(:info).with('')
-        expect(subject.logger).to receive(:info).with(%Q(Started POST "/api/1.0/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
-    end
   end
 
   describe '#after_failure' do
@@ -123,6 +109,19 @@ describe Grape::Middleware::Logger do
     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"))
+      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
   #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-middleware-logger
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Ryan Buckley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-08 00:00:00.000000000 Z
+date: 2015-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -58,15 +64,21 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-description: Logging middleware for Grape apps, similar to what Rails offers
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Logging middleware for the Grape framework, similar to what Rails offers
 email:
 - arebuckley@gmail.com
 executables: []
@@ -74,8 +86,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".ruby-gemset"
-- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -108,7 +118,7 @@ rubyforge_project:
 rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
-summary: Logging middleware for Grape apps
+summary: A logger for the Grape framework
 test_files:
 - spec/lib/grape/middleware/logger_spec.rb
 - spec/spec_helper.rb

data/.ruby-gemset

@@ -1 +0,0 @@
-grape-middleware-logger

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.1.5