rack-access_log 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56c846d27381681670964c37eb0f18f2b48f5e6a
+  data.tar.gz: b995a96573a52d908fc9f833dc0644d7683ba295
+SHA512:
+  metadata.gz: eab15a1e29481ecaf3d812e330cc7f29acff22bac4b85eb84713596a484ddf646966acea3fde36798c0c5120ce299d315bb8a8655fc90d6a287ec19bc6a78c5f
+  data.tar.gz: 8f179a2a3d1518a3d683193f031bdf3c8ac6095ec57b426082f1cf65cd4f0fc89f698c324378e88d96a4356e0ce4a80fe89737f46e07e0043592cca21a9e9a11

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,33 @@
+language: ruby
+script: rspec spec -f d
+
+install:
+  - gem update bundler
+  - bundle install
+
+rvm:
+  - 1.9
+  - 2.0.0
+  - 2.1.1
+  - 2.1.2
+  - 2.2.2
+  - 2.3.1
+  - 2.4.1
+  - jruby-19mode
+
+  - ruby-head
+  - jruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+
+env:
+  global:
+    - VERBOSE=true
+    - TIMEOUT=1
+
+branches:
+  only:
+    - master

data/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 adamluzsi@gmail.com. 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/

data/Gemfile

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

data/README.md

@@ -0,0 +1,64 @@
+# Rack::AccessLog
+
+This is a middleware for ruby / rack based webservice access logging.
+The implementation doesn't depend on any webframework or monkey patch.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-access_log'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-access_log
+
+## Usage
+
+#### First we need a logger that can accept and handle hash messages.
+
+You can use the ruby build in with "custom" formatter.
+
+```ruby
+require 'json'
+require 'logger'
+
+json_logger = Logger.new(STDOUT)
+json_logger.formatter = proc do |severity, datetime, progname, msg|
+  JSON.dump(msg) + "\n"
+end
+```
+
+Or you can use logger implementations such as [TwP/logging](https://github.com/TwP/logging) gem
+
+```ruby
+require 'logging'
+
+json_logger = Logging.logger["AccessLog"]
+appender = Logging.appenders.stdout(:layout => Logging.layouts.json)
+json_logger.add_appenders(appender)
+```
+
+#### Than use it in our middleware stack
+##### config.ru
+
+```ruby
+require 'rack/access_log'
+use Rack::AccessLog, json_logger
+
+require 'rack/response'
+run proc{|env| Rack::Response.new.finish }
+```
+
+That's all Folks!
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rack-access_log. 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.
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack/access_log"
+
+# 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(__FILE__)

data/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

data/lib/rack/access_log/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class AccessLog
+    VERSION = "0.1.0"
+  end
+end

data/lib/rack/access_log.rb

@@ -0,0 +1,60 @@
+require 'rack/access_log/version'
+require 'rack'
+require 'benchmark'
+
+module Rack
+  class AccessLog
+    def initialize(app, logger, config = {})
+      @app = app
+      @logger = logger
+      configure!(config)
+    end
+
+    def call(env)
+      status, header, body_lines, realtime = next_middleware_call_with_benchmarking(env)
+      @logger.info(create_log_message(env, status, realtime)) if tracked?(env)
+      [status, header, body_lines]
+    end
+
+    private
+
+    def tracked?(env)
+      !@exclude_paths.include?(env[Rack::PATH_INFO])
+    end
+
+    def create_log_message(env, status, realtime)
+      {
+        execution_time_sec: realtime,
+        remote_ip: remote_ip_by(env),
+        request_method: env[Rack::REQUEST_METHOD],
+        request_path: env[Rack::PATH_INFO],
+        query_string: env[Rack::QUERY_STRING],
+        response_status_code: status.to_i
+      }
+    end
+
+    def remote_ip_by(env)
+      env['HTTP_X_FORWARDED_FOR'] || env['REMOTE_ADDR'] || '-'
+    end
+
+    def next_middleware_call_with_benchmarking(env)
+      status = nil
+      header = nil
+      body_lines = nil
+      realtime = Benchmark.realtime do
+        status, header, body_lines = @app.call(env)
+      end
+      [status, header, body_lines, realtime]
+    end
+
+    def configure!(config)
+      @exclude_paths = [config.delete(:exclude_path)].flatten.compact.freeze
+      check_for_unrequired_options(config)
+    end
+
+    def check_for_unrequired_options(config)
+      invalid_config_options = config.keys
+      raise("invalid config: #{invalid_config_options.join(', ')}") unless invalid_config_options.empty?
+    end
+  end
+end

data/rack-access_log.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/access_log/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack-access_log'
+  spec.version       = Rack::AccessLog::VERSION
+  spec.authors       = ['Adam Luzsi']
+  spec.email         = ['smart-insight-dev@emarsys.com']
+
+  spec.summary       = 'This is a super simple access log middleware that can be used without any framework dependency'
+  spec.description   = 'This is a super simple access log middleware that can be used without any framework dependency'
+  spec.homepage      = 'https://github.com/emartech/rack-access_log'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rack'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: rack-access_log
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Luzsi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  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.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: This is a super simple access log middleware that can be used without
+  any framework dependency
+email:
+- smart-insight-dev@emarsys.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/access_log.rb
+- lib/rack/access_log/version.rb
+- rack-access_log.gemspec
+homepage: https://github.com/emartech/rack-access_log
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: This is a super simple access log middleware that can be used without any
+  framework dependency
+test_files: []