inital version

Author: David Roy

.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in grape-middleware-logger.gemspec
+# Specify your gem's dependencies in grape-middleware-logstasher.gemspec
 gemspec

README.md

@@ -3,6 +3,9 @@
 
 If you wanna use this gem, you'll need to be running Grape master [#dd0cae27](https://github.com/intridea/grape/commit/dd0cae274ee0017a22deef5e282b75cf25d65385) (April 30) or later. Otherwise, you'll have to wait for the release of 0.12.0
 
+## Cabbit Version
+This version is for providing these logs to logstash.
+
 ## Installation
 
 Add this line to your application's Gemfile:

grape-middleware-logger.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |spec|
   spec.name          = 'grape-middleware-logger'
   spec.version       = Grape::Middleware::Logger::VERSION
   spec.platform      = Gem::Platform::RUBY
-  spec.authors       = ['Ryan Buckley']
-  spec.email         = ['[email protected]']
+  spec.authors       = ['Ryan Buckley', 'David Roy']
+  spec.email         = ['[email protected]', '[email protected]']
   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      = ''

lib/grape/middleware/logger.rb

@@ -1,26 +1,43 @@
 require 'logger'
 require 'grape/middleware/globals'
+require 'grape/middleware/logger/version'
 
-# 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 log
+        @log ||= {
+          'timestamp' => start_time.iso8601,
+          'application' => '',
+          'service'     => '',
+          'fields'=> {
+            'method' =>   env['grape.request'].request_method,
+            'resource' => env['grape.request'].path,
+            'params' =>   parameters
+          },
+          'status_code' =>  '',
+          'completed_in' => '',
+          'errors' => ''
+        }
+      end
+
       def before
         start_time
         super
-        logger.info ''
-        logger.info %Q(Started #{env['grape.request'].request_method} "#{env['grape.request'].path}")
-        logger.info %Q(  Parameters: #{parameters})
       end
 
       def call!(env)
         @env = env
         before
         error = catch(:error) { @app_response = @app.call(@env); nil }
         if error.nil?
-          after(@app_response.first)
+          if @app_response.respond_to?(:first)
+            after(@app_response.first)
+          else
+            after(@app_response)
+          end
         else
           after_failure(error)
           throw(:error, error)
@@ -29,16 +46,17 @@ def call!(env)
       end
 
       def after(status)
-        logger.info "Completed #{status} in #{((Time.now - start_time) * 1000).round(2)}ms"
-        logger.info ''
+        log['status_code']  = status.to_s
+        log['completed_in'] = "#{((Time.now.utc - start_time) * 1000).round(2)}ms"
+        logger.info log
       end
 
       #
       # Helpers
       #
 
       def after_failure(error)
-        logger.info %Q(  Error: #{error[:message]}) if error[:message]
+        log['errors'] = %Q(Error: #{error[:message]}) if error[:message]
         after(error[:status])
       end
 
@@ -53,7 +71,7 @@ def parameters
       end
 
       def start_time
-        @start_time ||= Time.now
+        @start_time ||= Time.now.utc
       end
 
       def logger
@@ -62,5 +80,3 @@ def logger
     end
   end
 end
-
-require 'grape/middleware/logger/version'

lib/grape/middleware/logger/version.rb

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

spec/lib/grape/middleware/logger_spec.rb

@@ -53,13 +53,29 @@
     end
 
     describe 'integration' do
-      it 'properly logs requests', pending: 'Grape v0.12.0' do
+      let(:timestamp) { Time.now.utc.iso8601 }
+      let(:log) do
+        {
+          'timestamp'   => timestamp,
+          'application' => 'Cabbit',
+          'service'     => 'Cabbit_v1',
+          'fields' => {
+            'method' => 'POST',
+            'resource' => '/api/1.0/users',
+            'params' => {
+              'id' => '101001',
+              'name' => 'foo',
+              'password' => '[FILTERED]'
+            }
+          },
+          'status_code' =>  '200',
+          'completed_in'=> /\d.\d+ms/,
+          'errors' => ''
+        }
+      end
+      it 'properly logs requests' 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('')
+        expect(subject.logger).to receive(:info).with(log)
         subject.call!(env)
       end
     end
@@ -72,16 +88,6 @@
       expect(subject).to receive(:after).with(403)
       subject.after_failure(error)
     end
-
-    context 'when :message is set in the error object' do
-      let(:error) { { message: 'Oops, not found' } }
-
-      it 'logs the error message' do
-        allow(subject).to receive(:after)
-        expect(subject.logger).to receive(:info).with(Regexp.new(error[:message]))
-        subject.after_failure(error)
-      end
-    end
   end
 
   describe '#parameters' do