grape_logging 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e39d824c49d16aa7b96e3dc5886a6808ffc484e7
+  data.tar.gz: 143b23df9350b9ef6e15491fb7e14aaf79efc524
+SHA512:
+  metadata.gz: 07b2e707e3e1bc0ba946a15be38004ff39e2effd482084cc72f302279b6aa9d26b9009a0f385a0735a8347eb73c84956198d8aa34677d7e61b924fcf6f70d3c4
+  data.tar.gz: 4c4fa7aa76460e1a7abdbb553d5f5111499766ed284b3b703fb4baa9c7f4d6a91f193707fbc5934359feab7c87115e1d2b9d2db3c2b1dfd46de7d89b499b4625

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 aserafin
+
+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,66 @@
+# grape_logging
+
+[![Code Climate](https://codeclimate.com/github/aserafin/grape_logging/badges/gpa.svg)](https://codeclimate.com/github/aserafin/grape_logging)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'grape_logging'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grape_logging
+
+## Basic Usage
+
+In your api file (somewhere on the top)
+
+    logger.formatter = GrapeLogging::Formatters::Default.new
+    use GrapeLogging::Middleware::RequestLogger, { logger: logger }
+
+
+## Features
+
+### Log Format
+
+With the default configuration you will get nice log message
+
+    [2015-04-16 12:52:12 +0200] INFO -- 200 -- total=2.06 db=0.36 -- PATCH /your_app/endpoint params={"some_param"=>{"value_1"=>"123", "value_2"=>"456"}}
+
+If you prefer some other format I strongly encourage you to do pull request with new formatter class ;)
+
+### Logging to file and STDOUT
+
+You can to file and STDOUT at the same time, you just need to assign new logger
+
+    logger Logger.new GrapeLogging::MultiIO.new(STDOUT, File.open('path/to/your/logfile.log'), 'a'))
+
+### Logging exceptions
+
+If you want to log exceptions you can do it like this
+
+    class MyAPI < Grape::API
+      rescue_from :all do |e|
+        MyAPI.logger.error e
+        #do here whatever you originally planned to do :)
+      end
+    end
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/aserafin/grape_logging/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,2 @@
+require 'bundler/gem_tasks'
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'grape_logging'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/grape_logging.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape_logging/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'grape_logging'
+  spec.version       = GrapeLogging::VERSION
+  spec.authors       = ['aserafin']
+  spec.email         = ['adrian@softmad.pl']
+
+  spec.summary       = %q{Out of the box request logging for Grape!}
+  spec.description   = %q{This gem provides simple request logging for Grape with just 2 lines of code you have to put in your project! In return you will get response codes, parameters, total response duration and time spent in db (if you are using ActiveRecord.)}
+  spec.homepage      = 'http://github.com/aserafin/grape_logging'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'grape'
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/grape_logging/formatters/default.rb

@@ -0,0 +1,31 @@
+module GrapeLogging
+  module Formatters
+    class Default
+      def call(severity, datetime, _, data)
+        "[#{datetime}] #{severity} -- #{format(data)}\n"
+      end
+
+      def format(data)
+        if data.is_a?(String)
+          data
+        elsif data.is_a?(Exception)
+          format_exception(data)
+        elsif data.is_a?(Hash)
+          "#{data.delete(:status)} -- total=#{data.delete(:total)} db=#{data.delete(:db)} -- #{data.delete(:method)} #{data.delete(:path)} #{format_hash(data)}"
+        else
+          data.inspect
+        end
+      end
+
+      private
+      def format_hash(hash)
+        hash.keys.sort.map { |key| "#{key}=#{hash[key]}" }.join(' ')
+      end
+
+      def format_exception(exception)
+        backtrace_array = (exception.backtrace || []).map { |line| "\t#{line}" }
+        "#{exception.message}\n#{backtrace_array.join("\n")}"
+      end
+    end
+  end
+end

data/lib/grape_logging/middleware/request_logger.rb

@@ -0,0 +1,46 @@
+require 'grape/middleware/base'
+
+module GrapeLogging
+  module Middleware
+    class RequestLogger < Grape::Middleware::Base
+      def before
+        env[:db_duration] = 0
+
+        ActiveSupport::Notifications.subscribe('sql.active_record') do |*args|
+          event = ActiveSupport::Notifications::Event.new(*args)
+          env[:db_duration] += event.duration
+        end if defined?(ActiveRecord)
+      end
+
+      def call!(env)
+        original_response = nil
+
+        duration = Benchmark.realtime { original_response = super(env) }
+        logger.info parameters(original_response, duration)
+
+        original_response
+      end
+
+      protected
+        def parameters(response, duration)
+          {
+              path: request.path,
+              params: request.params,
+              method: request.request_method,
+              total: (duration * 1000).round(2),
+              db: request.env[:db_duration].round(2),
+              status: response.first
+          }
+        end
+
+      private
+      def logger
+        @logger ||= @options[:logger] || Logger.new(STDOUT)
+      end
+
+      def request
+        @request ||= ::Rack::Request.new(env)
+      end
+    end
+  end
+end

data/lib/grape_logging/multi_io.rb

@@ -0,0 +1,15 @@
+module GrapeLogging
+  class MultiIO
+    def initialize(*targets)
+      @targets = targets
+    end
+
+    def write(*args)
+      @targets.each {|t| t.write(*args)}
+    end
+
+    def close
+      @targets.each(&:close)
+    end
+  end
+end

data/lib/grape_logging/version.rb

@@ -0,0 +1,3 @@
+module GrapeLogging
+  VERSION = '1.0.0'
+end

data/lib/grape_logging.rb

@@ -0,0 +1,4 @@
+require 'grape_logging/multi_io'
+require 'grape_logging/version'
+require 'grape_logging/formatters/default'
+require 'grape_logging/middleware/request_logger'

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: grape_logging
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- aserafin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-16 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.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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'
+description: This gem provides simple request logging for Grape with just 2 lines
+  of code you have to put in your project! In return you will get response codes,
+  parameters, total response duration and time spent in db (if you are using ActiveRecord.)
+email:
+- adrian@softmad.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- grape_logging.gemspec
+- lib/grape_logging.rb
+- lib/grape_logging/formatters/default.rb
+- lib/grape_logging/middleware/request_logger.rb
+- lib/grape_logging/multi_io.rb
+- lib/grape_logging/version.rb
+homepage: http://github.com/aserafin/grape_logging
+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.6
+signing_key: 
+specification_version: 4
+summary: Out of the box request logging for Grape!
+test_files: []