move gem + code

Author: istana

.rspec

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

.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

Gemfile

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

README.md

@@ -1,2 +1,76 @@
 # rack-request-object-logger
-Log HTTP requests via Rack stack to a object. Can use any object.
+
+**Human description:** I created this to log all HTTP requests from my Rails application into MySQL database automatically. Then process via ElasticSearch.
+
+**General concept:** Log HTTP requests via Rack stack to an object. Can use any object, because logger uses dependency injection in setup. Be independent of Rails.
+
+Don't be confused with no commits in months or years. Rack middlewares rarely change. They just work for years.
+
+## Install gem
+
+```
+gem install rack-request-object-logger
+```
+
+## Gemfile
+
+```ruby
+gem 'rack-request-object-logger'
+```
+
+## Example - logging to SQL database in Rails
+
+generate a model for storage
+
+```
+$ bin/rails g model Sql::HttpRequest uuid:string headers:text
+
+```
+
+add JSON serialization
+```
+# app/models/sql/http_request.rb
+class Sql::HttpRequest < ApplicationRecord
+  serialize :headers, JSON
+end
+
+```
+
+add automatic logging via initializer
+```
+# config/initializers/rack_middlewares.rb
+
+Rails.application.config.middleware.use(RackRequestObjectLogger, Sql::HttpRequest)
+```
+
+## Rails integration/awareness
+
+The logger sets the UUID of request to match the request ID set by Rails.
+
+## Security considerations
+
+The middleware stores all HTTP headers, but strips all *active_dispatch*, *warden* and other stuff. That means HTTP basic auth credentials are stored and also data in query string.
+
+I've seen applications sending sensitive data in GET and even POST requests in a query string. Don't do that. Use POST body. Or modify the middleware to filter out them.
+
+## Author & License
+
+Copyright 2016 Ivan Stana, licensed under Apache 2.0 license. Enjoy.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+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
+
+There may be better alternatives for you:
+
+- http://bogomips.org/clogger/
+- http://www.rubydoc.info/github/rack/rack/Rack/CommonLogger
+- https://github.com/mattt/rack-http-logger

Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack/request/object/logger"
+
+# 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

bin/setup

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

lib/rack-request-object-logger.rb

@@ -0,0 +1,33 @@
+require 'rack'
+require 'securerandom'
+
+class RackRequestObjectLogger
+  def initialize(app, request_model)
+    @app = app
+    @model = request_model
+  end
+
+  def call(env)
+    request = Rack::Request.new(env)
+    # this may not be sufficient with warden/devise/other gems which put stuff into env
+    # also need to filter figaro stuff, stack settings from AWS
+    # TODO: pick only HTTP_* and the fields with ip address and CGI
+    # TODO: respect Rails request id
+    # TODO: filter sensitive params
+    # TODO: generally consider to whitelist fields instead of blacklist_
+    data = request.env.reject{|header, value| !value.is_a?(String) || header =~ /\Aactive_dispatch/ }
+
+    m = @model.new
+    # Rails+Puma adds request.uuid, but cannot use here
+    # https://github.com/anveo/rack-request-id
+    m.uuid = SecureRandom.uuid
+    m.headers = data
+
+    if !m.save
+      # TODO logger or something
+      # I'm too lazy
+    end
+
+    @app.call(env)
+  end
+end

lib/rack/request/object/logger.rb

@@ -0,0 +1,11 @@
+require "rack/request/object/logger/version"
+
+module Rack
+  module Request
+    module Object
+      module Logger
+        # Your code goes here...
+      end
+    end
+  end
+end