rack-json_common_logger 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: efd4baac67a2b1a6cc8858bd15e8d869cff7856e
+  data.tar.gz: a82ba32ceced11a942b72dcc8d1259a7e17afd1e
+SHA512:
+  metadata.gz: c82aa7ff8ebe797b845b80cb26f72e10da5bffbe71ac630ef59e04a6bdc40f138ea081b08c43606f86b08251032f6a7f44dc0f02e43e670af130e84b2cd8891e
+  data.tar.gz: 919d014c78ab31b038f792d43e3e62367457faf84b04aff565ed3ca357b85b14986680e7ae5e19f333b35a3c0d74c9b9b0400d472e7e4d4b37ee927d846fb5e4

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at bisusubedi@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/README.md

@@ -0,0 +1,39 @@
+Experimental, Not ready for production usage.
+# Rack::JsonCommonLogger
+
+A Rack commonlogger based json logger middleware.
+    Its a gem which monkey patches rack commomlogger module to write rack logs in json format
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-json_common_logger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-json_common_logger
+
+## Usage
+```ruby
+    logger = Logger.new(<your-log-device>)
+    use Rack::JsonCommonLogger, logger
+```
+put this code in config.ru file or wherever is your in rack builder setup
+
+## 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/bisusubedi/rack-json_common_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.
+

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

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/json_common_logger.rb

@@ -0,0 +1,62 @@
+require 'rack'
+require 'json'
+module Rack
+  class JsonCommonLogger < Rack::CommonLogger
+    private
+    def log(env, status, header, began_at)
+      msg = JsonLogFormatter.new(env, header, status, began_at).to_json
+      logger = @logger || env['rack.errors']
+      logger.respond_to?(:write) ? logger.write(msg) : logger << msg
+    end
+  end
+
+  # Formats request log from rack env to json
+  class JsonLogFormatter
+    def initialize(env, headers, status, began_at)
+      @env = env
+      @began_at = began_at
+      @status = status
+      @headers = headers
+    end
+
+    def to_json
+      "#{message.to_json}\n"
+    end
+
+    def message
+      now = Time.now.utc
+      {
+        timestamp: now.strftime('%Y-%m-%dT%H:%M:%SZ'),
+        method: env[REQUEST_METHOD],
+        remote_address: remote_address,
+        location: location,
+        params: (env['rack.request.form_hash'] || {}),
+        query_string: query_string,
+        status: status.to_s[0..3],
+        length: extract_content_length,
+        duration: (now - began_at)
+      }
+    end
+
+    private
+
+    def extract_content_length
+      value = headers[CONTENT_LENGTH] or return '-'
+      value.to_s == '0' ? '-' : value
+    end
+
+    def remote_address
+      env['HTTP_X_FORWARDED_FOR'] || env["REMOTE_ADDR"] || "-"
+    end
+
+    def query_string
+      env[QUERY_STRING].empty? ? '' : "?#{env[QUERY_STRING]}"
+    end
+
+    def location
+      "#{env['rack.url_scheme']}://#{env['HTTP_HOST']}#{env['PATH_INFO']}"
+    end
+
+    attr_accessor :env, :headers, :status, :began_at
+  end
+end

data/rack-json_common_logger.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-json_common_logger"
+  spec.version       = '0.1.1'
+  spec.authors       = ["Bishnu Subedi"]
+  spec.email         = ["bisusubedi@gmail.com"]
+
+  spec.summary       = %q{ A Rack commonlogger based json logger middleware }
+  spec.description   = %q{ Monkey patching of rack commomlogger module to write rack logs in json format.}
+  spec.homepage      = "https://github.com/bisusubedi/rack-json_common_logger"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   # spec.metadata['allowed_push_host'] = "https://gems.my-company.example"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  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 "rack", "~> 1.6.4"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: rack-json_common_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Bishnu Subedi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: " Monkey patching of rack commomlogger module to write rack logs in json
+  format."
+email:
+- bisusubedi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/json_common_logger.rb
+- rack-json_common_logger.gemspec
+homepage: https://github.com/bisusubedi/rack-json_common_logger
+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: A Rack commonlogger based json logger middleware
+test_files: []