grape-middleware-logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38faa42e694ac5c8b974975c8e5f8819c073c028
+  data.tar.gz: d5da71383af6b787ad2380e7d408ea3974553c4a
+SHA512:
+  metadata.gz: 2ad87065915b6f9a6b932b7ac198434de5cda37b55812dadc716544c1eb346fb602d5e4be32a006516cc4cba1955e44d9b3543f1e711f905bff41452c777216e
+  data.tar.gz: cf6f37a8a9878aa7d677b401c1f7aac37cdc559fc572057d6f0fcdcd939d798358b94f10252516ddf225a37abb24dd8bc606f28c793f19757afef8cc7bbdee69

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ryan Buckley
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# Grape::Middleware::Logger
+
+Dead until brought to life with the release of Grape v0.12.0
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grape-middleware-logger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grape-middleware-logger
+
+## 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)
+for easily logging error responses. Borrowed some motivation from the [grape_logging](https://github.com/aserafin/grape_logging) gem
+and would love to see these two consolidated at some point.
+
+## Contributing
+
+1. Fork it ( https://github.com/ridiculous/grape-middleware-logger/fork )
+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`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+desc 'Run specs'
+task default: :spec

data/grape-middleware-logger.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape/middleware/logger'
+
+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         = ['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.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'grape'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '>= 3.0'
+end

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

@@ -0,0 +1,7 @@
+module Grape
+  module Middleware
+    class Logger
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/grape/middleware/logger.rb

@@ -0,0 +1,64 @@
+require 'logger'
+require 'grape/middleware/globals'
+
+module Grape
+  module Middleware
+    class Logger < Grape::Middleware::Globals
+
+      #
+      # Overrides
+      #
+
+      def call!(env)
+        @env = env
+        _before
+        error = catch(:error) { @app_response = @app.call(@env); nil }
+        if error
+          after_failure(error)
+          throw(:error, error)
+        else
+          after(@app_response.first)
+        end
+        @app_response
+      end
+
+      def after(status)
+        logger.info "Completed #{status} in #{((Time.now - @start_time) * 1000).round(2)}ms"
+        logger.info ''
+      end
+
+      #
+      # Helpers
+      #
+
+      # @todo rename to +before+ when Grape v0.12.0 is released
+      def _before
+        @start_time = Time.now
+        logger.info ''
+        logger.info %Q(Started #{env['grape.request'].request_method} "#{env['grape.request'].path}")
+        logger.info %Q(  Parameters: #{parameters})
+      end
+
+      def after_failure(error)
+        logger.info %Q(  Error: #{error[:message]}) if error[:message]
+        after(error[:status])
+      end
+
+      def parameters
+        request_params = env['grape.request.params'].to_hash
+        request_params.merge!(env['action_dispatch.request.request_parameters'] || {})
+        if @options[:filter]
+          @options[:filter].filter(request_params)
+        else
+          request_params
+        end
+      end
+
+      def logger
+        @logger ||= @options[:logger] || ::Logger.new(STDOUT)
+      end
+    end
+  end
+end
+
+require 'grape/middleware/logger/version'

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

@@ -0,0 +1,132 @@
+require 'spec_helper'
+require 'grape/middleware/logger'
+
+describe Grape::Middleware::Logger do
+  let(:app) { double('app') }
+  let(:options) { { filter: ParamFilter.new, logger: Object.new } }
+
+  subject { described_class.new(app, options) }
+
+  let(:app_response) { [200, {}, 'Hello World'] }
+  let(:env) {
+    {
+      'grape.request' => OpenStruct.new(request_method: 'POST', path: '/api/1.0/users'),
+      'grape.request.params' => {
+        'id' => '101001'
+      },
+      'action_dispatch.request.request_parameters' => {
+        'name' => 'foo',
+        'password' => 'access'
+      }
+    }
+  }
+  describe '#call!' do
+    context 'when calling the app results in an error response' do
+      let(:error) { { status: 400 } }
+
+      it 'calls +after_failure+ and rethrows the error' do
+        expect(app).to receive(:call).with(env).and_throw(:error, error)
+        expect(subject).to receive(:_before)
+        expect(subject).to receive(:after_failure).with(error)
+        expect(subject).to receive(:throw).with(:error, error)
+        subject.call!(env)
+      end
+    end
+
+    context 'when there is no error' do
+      it 'calls +after+ with the correct status' do
+        expect(app).to receive(:call).with(env).and_return(app_response)
+        expect(subject).to receive(:_before)
+        expect(subject).to receive(:after).with(200)
+        subject.call!(env)
+      end
+
+      it 'returns the @app_response' do
+        expect(app).to receive(:call).with(env).and_return(app_response)
+        allow(subject).to receive(:_before)
+        allow(subject).to receive(:after)
+        expect(subject.call!(env)).to eq app_response
+      end
+    end
+
+    describe 'integration' do
+      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('')
+        subject.call!(env)
+      end
+    end
+  end
+
+  describe '#after_failure' do
+    let(:error) { { status: 403 } }
+
+    it 'calls +after+ with the :status' do
+      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
+    before { subject.instance_variable_set(:@env, env) }
+
+    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" })
+        subject.parameters
+      end
+
+      it 'returns the filtered results' do
+        expect(subject.parameters).to eq({ "id" => '101001', "name" => "foo", "password" => "[FILTERED]" })
+      end
+    end
+
+    context 'when @options[:filter] is nil' do
+      let(:options) { {} }
+
+      it 'returns the params extracted out of @env' do
+        expect(subject.parameters).to eq({ "id" => '101001', "name" => "foo", "password" => "access" })
+      end
+    end
+  end
+
+  describe '#logger' do
+    context 'when @options[:logger] is nil' do
+      let(:options) { {} }
+
+      it 'defaults to the the standard Logger' do
+        expect(subject.logger).to be_a(Logger)
+      end
+    end
+
+    context 'when @options[:logger] is set' do
+      it 'returns the logger object' do
+        expect(subject.logger).to eq options[:logger]
+      end
+    end
+  end
+
+  #
+  # Test class
+  #
+
+  ParamFilter = Class.new do
+    def filter(opts)
+      opts.each_pair { |key, val| val[0..-1] = '[FILTERED]' if key == 'password' }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'ostruct'
+
+RSpec.configure do |config|
+  config.raise_errors_for_deprecations!
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: grape-middleware-logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Buckley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  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
+email:
+- arebuckley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- grape-middleware-logger.gemspec
+- lib/grape/middleware/logger.rb
+- lib/grape/middleware/logger/version.rb
+- spec/lib/grape/middleware/logger_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Logging middleware for Grape apps
+test_files:
+- spec/lib/grape/middleware/logger_spec.rb
+- spec/spec_helper.rb