rack-request-object-logger 2.0.1 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 68113b8a402b14c8a318bf7f4d741b1cdea58b5d
-  data.tar.gz: f3b79f22b3c49915e445664b20bac57d603daebb
+SHA256:
+  metadata.gz: 1f88b6570bfb9f0ce097804e7251033d148625664ed132ce82f9ed451786881b
+  data.tar.gz: 3c3944e7642717a2e4f11cf8f4f4386fcb0e5f140cfa751ae3484cc66341aafa
 SHA512:
-  metadata.gz: a5df959bfad13fd9df2acb70480fc5e8f59d7d058c5e0e6a250838eea9df3284240a8cccd3fce58889d542a9686ef8a19b7f7e2858edfe854333a64f25f2c5bc
-  data.tar.gz: 71f93253e15c2b0680be1ae37ceb318c4975260cc26046cccaff25df0813a17cf68ceb96bbaf8fa89df14f6966963dc97cab28ef964069118087597a2474d121
+  metadata.gz: bbba4358191665de50681e94fb9e9af6406facf9388cd2065c9bb03e99c74a5716306efcbc8ea369ef0bbfee77a2159aaafd8e0041a9f5448a479f3c89b4b918
+  data.tar.gz: 669313528821b1bc40985ae94d6eafe5d209f94c3300f09036c860fdc64c93e48b1bd6946c5f7639a8661263a762bda4dc2e57e274e7dfb16434d3cb55775b0b

data/.travis.yml

@@ -1,15 +1,18 @@
 sudo: false
 language: ruby
+services:
+  - mysql
 rvm:
-  - 2.2.6
-  - 2.3.3
-  - 2.4.0
-  - jruby-9.1.6.0
-before_install: gem install bundler -v 1.13.7
+  - 2.5.4
+  - 2.6.3
+  - truffleruby
+before_install:
+  - gem update --system
+  - gem install bundler
 cache: bundler
 matrix:
   include:
      - rvm: ruby-head
   allow_failures:
     - rvm: ruby-head
-  fast_finish: true
+  fast_finish: true

data/README.md

@@ -1,5 +1,4 @@
-[![Build Status](http://img.shields.io/travis/starmammoth/rack-request-object-logger.svg?style=flat-square)](https://travis-ci.org/starmammoth/rack-request-object-logger)
-[![Code Climate](http://img.shields.io/codeclimate/github/starmammoth/rack-request-object-logger.svg?style=flat-square)](https://codeclimate.com/github/starmammoth/rack-request-object-logger)
+[![Build Status](http://img.shields.io/travis/istana/rack-request-object-logger.svg?style=flat-square)](https://travis-ci.org/istana/rack-request-object-logger)
 [![Gem Version](http://img.shields.io/gem/v/rack-request-object-logger.svg?style=flat-square)](https://rubygems.org/gems/rack-request-object-logger)
 [![License](http://img.shields.io/:license-apache-blue.svg?style=flat-square)](http://www.apache.org/licenses/LICENSE-2.0.html)
 
@@ -25,28 +24,32 @@ gem 'rack-request-object-logger'
 
 ## Rubies Support
 
-Ruby 2.1+, jRuby and Rubinius 3.69+
+Tested with Matz Ruby 2.5, 2.6 and Truffleruby.
+
+Should work with Ruby 2.1+, jRuby and Rubinius 3.69+ (is dead!) and Truffleruby.
 
 ## Roadmap
 
 While the code works flawlessly
 
-- performance specs don't work on jruby, but works on MRI and Rubinius 3.60
+Bug: I learned at EuRuKo 2018 that my implementation of timings is wrong and not very accurate.
 
 ## Example - logging to SQL database in Rails
 
 generate a model for storage
 
 ```bash
-$ bin/rails g model Sql::HttpRequest uid:string data:text
+# you need to add 'limit: 6' to application_server_request_start and application_server_request_end
+# to have subsecond resolution please see examples/db/migrate/
+$ bin/rails g model AnalyticsHttpRequest uid:string data:text status_code:integer application_server_request_start:datetime application_server_request_end:datetime
 
 ```
 
 add JSON serialization
 
 ```ruby
-# app/models/sql/http_request.rb
-class Sql::HttpRequest < ApplicationRecord
+# app/models/analytics_http_request.rb
+class AnalyticsHttpRequest < ApplicationRecord
   serialize :data, JSON
 end
 
@@ -57,7 +60,7 @@ add automatic logging via initializer
 ```ruby
 # config/initializers/rack_middlewares.rb
 
-Rails.application.config.middleware.use(RackRequestObjectLogger, Sql::HttpRequest)
+Rails.application.config.middleware.use(RackRequestObjectLogger, AnalyticsHttpRequest)
 ```
 
 # Performance
@@ -76,7 +79,7 @@ I've seen applications sending sensitive data in GET and even POST requests in a
 
 ## License & Author
 
-Copyright 2016 Ivan Stana
+Copyright 2016-2019 Ivan Stana
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -100,7 +103,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/starmammoth/rack-request-object-logger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/istana/rack-request-object-logger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## Alternatives
 

data/examples/rails5/app/models/http_request.rb

@@ -0,0 +1,3 @@
+class AnaylticsHttpRequest < ApplicationRecord
+  serialize :data, JSON
+end

data/examples/rails5/config/log_http_request.rb

@@ -0,0 +1 @@
+Rails.application.config.middleware.use "RackRequestObjectLogger", AnalyticsHttpRequest

data/examples/rails5/db/migrate/20170211004327_create_http_requests.rb

@@ -0,0 +1,15 @@
+class CreateAnalyticsHttpRequests < ActiveRecord::Migration[5.0]
+  def change
+    create_table :analytics_http_requests do |t|
+      t.string :uid
+      t.text :data
+      t.integer :status_code
+      # with limit: 6 we will store nanosecond resolution
+      # for statistics and performance monitoring sub-second resolution is a must
+      t.datetime :application_server_request_start, limit: 6
+      t.datetime :application_server_request_end, limit: 6
+
+      t.timestamps
+    end
+  end
+end

data/lib/rack-request-object-logger/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 class RackRequestObjectLogger
-  VERSION = "2.0.1"
+  VERSION = "3.0.3"
 end

data/rack-request-object-logger.gemspec

@@ -24,12 +24,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rack", "> 0", "< 3.0"
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 12.0"
-  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.8"
   spec.add_development_dependency "rspec-benchmark", "~> 0"
   spec.add_development_dependency "pry", "~> 0"
-  spec.add_development_dependency "activerecord", '>= 4.2', "< 6.0"
-  spec.add_development_dependency "sqlite3", "~> 1.3" unless RUBY_PLATFORM == 'java'
-  spec.add_development_dependency "activerecord-jdbcsqlite3-adapter", "~> 1.3" if RUBY_PLATFORM == 'java'
+  spec.add_development_dependency "activerecord", '>= 6.0', "< 7.0"
+  spec.add_development_dependency "sqlite3", "~> 1.4" unless RUBY_PLATFORM == 'java'
+  spec.add_development_dependency "mysql2", "~> 0.5" unless RUBY_PLATFORM == 'java'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-request-object-logger
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.3
 platform: ruby
 authors:
 - Ivan Stana
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-11 00:00:00.000000000 Z
+date: 2019-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -36,42 +36,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: rspec-benchmark
   requirement: !ruby/object:Gem::Requirement
@@ -106,34 +106,48 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.5'
 description: Log HTTP requests via Rack stack to an object. You can use any object,
   i.e. ActiveRecord model
 email:
@@ -152,6 +166,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/rails5/app/models/http_request.rb
+- examples/rails5/config/log_http_request.rb
+- examples/rails5/db/migrate/20170211004327_create_http_requests.rb
 - lib/rack-request-object-logger.rb
 - lib/rack-request-object-logger/version.rb
 - performance/active_record_model_spec.rb
@@ -177,8 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Log HTTP requests via Rack stack to an object. You can use any object.