rack-request-object-logger 2.0.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 68113b8a402b14c8a318bf7f4d741b1cdea58b5d
-  data.tar.gz: f3b79f22b3c49915e445664b20bac57d603daebb
+SHA256:
+  metadata.gz: f2df7642c85cddc3a1947c7d3b7191fcbee553877a19ca47ffd9b3a46a5bc0fa
+  data.tar.gz: 571cf74cb5555caf7d620c109e9b037cbf3a6330a44b354e44e5b1fd2c89b3b6
 SHA512:
-  metadata.gz: a5df959bfad13fd9df2acb70480fc5e8f59d7d058c5e0e6a250838eea9df3284240a8cccd3fce58889d542a9686ef8a19b7f7e2858edfe854333a64f25f2c5bc
-  data.tar.gz: 71f93253e15c2b0680be1ae37ceb318c4975260cc26046cccaff25df0813a17cf68ceb96bbaf8fa89df14f6966963dc97cab28ef964069118087597a2474d121
+  metadata.gz: b43ceb51e1f0db58d96b83988a925e790b9dd5051acd203e980c0b4b3962976669f23518129c4d155619ad25f100f6d3c71cd0ec655657d5d7031370b24a4c0e
+  data.tar.gz: 12254a4a8c854a1da0583c5a329e229f5169f8b538023732c693b7a8ca2abc3db7a490c6914c7950946c544e5933930179499e4d1e2d42f9a2b765b9262841b5

data/.github/workflows/ruby.yml

@@ -0,0 +1,26 @@
+name: github-actions-rails
+
+on:
+  pull_request:
+    branches: ['*']
+  push:
+    branches: [master]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.7', '3.0', '3.1', '3.2', '3.3', head, truffleruby, truffleruby-head]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler: default
+          bundler-cache: true
+      - name: Run tests
+        env:
+          RAILS_ENV: test
+        run: bundle exec rake

data/README.md

@@ -1,15 +1,12 @@
-[![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)
+![example workflow](https://github.com/istana/rack-request-object-logger/actions/workflows/ruby.yml/badge.svg)
 [![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)
 
 # rack-request-object-logger
 
-**Human description:** I created this to log all HTTP requests from my Rails application into MySQL database automatically. Then process and search via ElasticSearch.
+The project is a Rack middleware to automatically log a HTTP request to a custom object.
 
-**General concept:** Log HTTP requests via Rack stack to an object. Use any object, because logger uses dependency injection in the constructor. Be independent from Rails.
-
-Don't be confused with no commits in months or years. Rack middlewares rarely change. They just work.
+There might be no commits in months or years. Rack middlewares rarely change.
 
 ## Install gem
 
@@ -25,39 +22,30 @@ gem 'rack-request-object-logger'
 
 ## Rubies Support
 
-Ruby 2.1+, jRuby and Rubinius 3.69+
+Tested with Matz Ruby 2.7, 3.0, 3.1, 3.2, 3.3, head, and ruffleruby, truffleruby-head.
+
+Should work also with jRuby, just sqlite3 adapter supports only Rails 7 and tests require a more recent Rails.
 
 ## 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
-
-```
-
-add JSON serialization
-
-```ruby
-# app/models/sql/http_request.rb
-class Sql::HttpRequest < ApplicationRecord
-  serialize :data, JSON
-end
-
+$ bin/rails g model AnalyticsRequest uid:string data:jsonb status_code:integer application_server_request_start:datetime application_server_request_end:datetime
 ```
 
 add automatic logging via initializer
 
 ```ruby
-# config/initializers/rack_middlewares.rb
+# config/initializers/log_requests.rb
 
-Rails.application.config.middleware.use(RackRequestObjectLogger, Sql::HttpRequest)
+Rails.application.config.middleware.use(RackRequestObjectLogger, AnalyticsHttpRequest)
 ```
 
 # Performance
@@ -76,7 +64,7 @@ I've seen applications sending sensitive data in GET and even POST requests in a
 
 ## License & Author
 
-Copyright 2016 Ivan Stana
+Copyright 2016-2024 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 +88,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/Rakefile

@@ -1,6 +1,12 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec'
+end
 
-task :default => :spec
+RSpec::Core::RakeTask.new(:spec_performance) do |t|
+  t.pattern = 'performance'
+end
+
+task :default => [:spec, :spec_performance]

data/examples/rails7/config/initializers/log_http_request.rb

@@ -0,0 +1,9 @@
+require Rails.root.join('app', 'models', 'application_record').to_s
+require Rails.root.join('app', 'models', 'analytics_request').to_s
+
+Rails.configuration.before_initialize do
+  Rails.application.config.middleware.use(
+    RackRequestObjectLogger,
+    ::AnalyticsRequest
+  )
+end

data/examples/rails7/db/migrate/20240917151639_create_analytics_requests.rb

@@ -0,0 +1,14 @@
+class CreateAnalyticsRequests < ActiveRecord::Migration[7.2]
+  def change
+    create_table :analytics_requests, id: :uuid do |t|
+      t.text :uid
+      t.json :data
+      t.integer :status_code
+      t.datetime :application_server_request_start
+      t.datetime :application_server_request_end
+      t.references :requestable, polymorphic: true, null: true, type: :uuid, index: true
+
+      t.timestamps
+    end
+  end
+end

data/examples/rails7/models/analytics_request.rb

@@ -0,0 +1,3 @@
+class AnalyticsRequest < ::ApplicationRecord
+  belongs_to :requestable, polymorphic: true, required: false
+end

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

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

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

@@ -17,8 +17,7 @@ class RackRequestObjectLogger
     logger_object = @model.new
     logger_object.application_server_request_start = start_time
     logger_object.application_server_request_end = end_time
-    request = Rack::Request.new(env)
-    logger_object.data = request.env.select do |header, value|
+    logger_object.data = env.select do |header, value|
       # don't bother with values other than a string
       next if !value.is_a?(String)
       # https://tools.ietf.org/html/rfc3875 CGI 1.1 spec
@@ -38,7 +37,7 @@ class RackRequestObjectLogger
       ].include?(header) || ['HTTP', 'HTTPS'].include?(header) || header =~ /\AHTTP_\w+\z/ ||
       ['REQUEST_URI', 'ORIGINAL_FULLPATH', 'ORIGINAL_SCRIPT_NAME'].include?(header)
     end
-    logger_object.uid = request.env['action_dispatch.request_id'] || SecureRandom.uuid
+    logger_object.uid = env['action_dispatch.request_id'] || SecureRandom.uuid
     logger_object.status_code = app_result.first
     logger_object.save
     app_result

data/rack-request-object-logger.gemspec

@@ -11,25 +11,31 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Ivan Stana"]
   spec.email         = ["ronon@myrtana.sk"]
 
-  spec.summary       = %q{Log HTTP requests via Rack stack to an object. You can use any object.}
-  spec.description   = %q{Log HTTP requests via Rack stack to an object. You can use any object, i.e. ActiveRecord model}
-  spec.homepage      = "https://github.com/starmammoth/rack-request-object-logger"
+  spec.summary       = %q{The project is a Rack middleware to automatically log a HTTP request to a custom object.}
+  spec.description   = %q{The project is a Rack middleware to automatically log a HTTP request to a custom object.}
+  spec.homepage      = "https://github.com/istana/rack-request-object-logger"
   spec.license       = "Apache-2.0"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(test|spec|features|performance)/})
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   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.metadata = {
+    "bug_tracker_uri"   => "https://github.com/istana/rack-request-object-logger/issues",
+    "homepage_uri"      => "https://github.com/istana/rack-request-object-logger",
+    "source_code_uri"   => "https://github.com/istana/rack-request-object-logger",
+  }
+
+  spec.add_dependency "rack", "> 0", "< 4.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13"
+  spec.add_development_dependency "rspec", "~> 3.13"
   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', "< 8.0"
+  spec.add_development_dependency "sqlite3", "<= 2.1" 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: 4.0.0
 platform: ruby
 authors:
 - Ivan Stana
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2017-02-11 00:00:00.000000000 Z
+date: 2024-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -19,7 +19,7 @@ dependencies:
         version: '0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,49 +29,49 @@ dependencies:
         version: '0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     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: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: rspec-benchmark
   requirement: !ruby/object:Gem::Requirement
@@ -106,45 +106,45 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '8.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: '8.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '1.3'
-description: Log HTTP requests via Rack stack to an object. You can use any object,
-  i.e. ActiveRecord model
+        version: '2.1'
+description: The project is a Rack middleware to automatically log a HTTP request
+  to a custom object.
 email:
 - ronon@myrtana.sk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
@@ -152,17 +152,20 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/rails7/config/initializers/log_http_request.rb
+- examples/rails7/db/migrate/20240917151639_create_analytics_requests.rb
+- examples/rails7/models/analytics_request.rb
 - lib/rack-request-object-logger.rb
 - lib/rack-request-object-logger/version.rb
-- performance/active_record_model_spec.rb
-- performance/in_memory_model_spec.rb
-- performance/performance_helper.rb
 - rack-request-object-logger.gemspec
-homepage: https://github.com/starmammoth/rack-request-object-logger
+homepage: https://github.com/istana/rack-request-object-logger
 licenses:
 - Apache-2.0
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/istana/rack-request-object-logger/issues
+  homepage_uri: https://github.com/istana/rack-request-object-logger
+  source_code_uri: https://github.com/istana/rack-request-object-logger
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -177,9 +180,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.5.16
+signing_key:
 specification_version: 4
-summary: Log HTTP requests via Rack stack to an object. You can use any object.
+summary: The project is a Rack middleware to automatically log a HTTP request to a
+  custom object.
 test_files: []

data/.travis.yml

@@ -1,15 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.2.6
-  - 2.3.3
-  - 2.4.0
-  - jruby-9.1.6.0
-before_install: gem install bundler -v 1.13.7
-cache: bundler
-matrix:
-  include:
-     - rvm: ruby-head
-  allow_failures:
-    - rvm: ruby-head
-  fast_finish: true

data/performance/active_record_model_spec.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-require_relative 'performance_helper'
-require_relative '../spec/spec_data'
-require 'active_record'
-
-RSpec.describe "Performance testing with an ActiveRecord class and SQLite3 database", performance: true do
-  include RSpec::Benchmark::Matchers
-  include_context 'spec_data'
-
-  class RequestActiveRecordLog < ActiveRecord::Base
-    serialize :headers, JSON
-  end
-
-  class CreateRequestActiveRecordLog < ActiveRecord::Migration[4.2]
-    def change
-      create_table :request_active_record_logs do |t|
-        t.integer :uid
-        t.text :data
-        t.time :application_server_request_start
-        t.time :application_server_request_end
-      end
-    end
-  end
-
-  let(:app) { proc{ [200, {}, ['Hello, world.']] } }
-  let(:stack) { RackRequestObjectLogger.new(app, RequestActiveRecordLog) }
-  let(:request) { Rack::MockRequest.new(stack) }
-
-  after { File.unlink 'active_record_performance.sqlite3' }
-
-  it 'much fast. wow' do
-    set_headers(rails5_puma_headers)
-
-    ActiveRecord::Base.establish_connection(
-      adapter: 'sqlite3',
-      database: 'active_record_performance.sqlite3'
-    )
-    CreateRequestActiveRecordLog.migrate(:up)
-    expect { request.get('http://localhost:4000/doge') }.to perform_at_least(500).ips
-  end
-end

data/performance/in_memory_model_spec.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-require_relative 'performance_helper'
-require_relative '../spec/spec_data'
-
-RSpec.describe "Performance testing with a dummy class", performance: true do
-  include RSpec::Benchmark::Matchers
-  include_context 'spec_data'
-
-  let(:app) { proc{ [200, {}, ['Hello, world.']] } }
-  let(:stack) { RackRequestObjectLogger.new(app, RequestDummyLog) }
-  let(:request) { Rack::MockRequest.new(stack) }
-
-  let(:logger_object) { RequestDummyLog.new }
-  before { allow(RequestDummyLog).to receive(:new).and_return(logger_object) }
-
-  it 'much fast. wow' do
-    set_headers(rails5_puma_headers)
-    expect { request.get('http://localhost:4000/doge') }.to perform_at_least(5000).ips
-  end
-end

data/performance/performance_helper.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-require 'bundler/setup'
-require 'rspec-benchmark'
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
-require "rack-request-object-logger"