rack-ougai 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27e100432cac9884d52ad4933f9d3224a2256e62
+  data.tar.gz: cea9f134706c03c91166c25dffef970ccdce29a3
+SHA512:
+  metadata.gz: 9ee784842d6d78fb28f3d056cfbc1d38acd9b4ad4f5ce8113e977cbbfd9f640bee907850c0429eb2ffffa03dc5eebcd47203b22020e30c9036e187dd64e50ee6
+  data.tar.gz: 73f60d0fa8de95aad6437376d9e6b7be15a4f93c71217ea525989b05baee2fc832f9d083029a0a813a7da09b10540b88c85737668c603e7d02e8f7e74d04019c

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,162 @@
+# Relaxed.Ruby.Style
+## Version 2.1
+
+Style/Alias:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylealias
+
+Style/AsciiComments:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleasciicomments
+
+Style/BeginBlock:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylebeginblock
+
+Style/BlockDelimiters:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleblockdelimiters
+
+Style/CommentAnnotation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylecommentannotation
+
+Style/Documentation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledocumentation
+
+Layout/DotPosition:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#layoutdotposition
+
+Style/DoubleNegation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledoublenegation
+
+Style/EndBlock:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleendblock
+
+Style/FormatString:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleformatstring
+
+Style/IfUnlessModifier:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleifunlessmodifier
+
+Style/Lambda:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylelambda
+
+Style/ModuleFunction:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylemodulefunction
+
+Style/MultilineBlockChain:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylemultilineblockchain
+
+Style/NegatedIf:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylenegatedif
+
+Style/NegatedWhile:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylenegatedwhile
+
+Style/ParallelAssignment:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleparallelassignment
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylepercentliteraldelimiters
+
+Style/PerlBackrefs:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleperlbackrefs
+
+Style/Semicolon:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesemicolon
+
+Style/SignalException:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesignalexception
+
+Style/SingleLineBlockParams:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesinglelineblockparams
+
+Style/SingleLineMethods:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesinglelinemethods
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#layoutspacebeforeblockbraces
+
+Layout/SpaceInsideParens:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#layoutspaceinsideparens
+
+Style/SpecialGlobalVars:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylespecialglobalvars
+
+Style/StringLiterals:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylestringliterals
+
+Style/TrailingCommaInArguments:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styletrailingcommainarguments
+
+Style/TrailingCommaInLiteral:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styletrailingcommainliteral
+
+Style/WhileUntilModifier:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylewhileuntilmodifier
+
+Style/WordArray:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylewordarray
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#lintambiguousregexpliteral
+
+Lint/AssignmentInCondition:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#lintassignmentincondition
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+

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 ed@edropple.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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rack-ougai.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Toshimitsu Takahashi, Ed Ropple
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# Rack::Ougai #
+`Rack::Ougai` replaces the Rack logging system with an [Ougai](https://github.com/tilfin/ougai) logger
+that supports Bunyan-styled structured logging in JSON. It includes a few options for building those logs,
+as well as integration with (`Rack::RequestID`)[https://github.com/dancavallaro/rack-requestid].
+
+## Installation ##
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-ougai'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-ougai
+
+## Usage ##
+Your `config.ru` should include directives similar to these. Obviously, `Rack::RequestID` is
+optional, but `Rack::Ougai::Logger` (or another logger provider) should be high in your middleware
+stack so as to push a logger down into the subsequent middleware.
+
+```
+require 'rack/ougai'
+require 'rack/requestid'
+
+use Rack::RequestID # makes sure `env` has an X-Request-Id header
+
+use Rack::Ougai::Logger, Logger::INFO # see Log Providers below
+use Rack::Ougai::AttachRequestID # Replaces logger with a child logger that's tagged with the request ID
+
+use Rack::Ougai::LogRequests # logs every request with timing data, request result, etc.
+```
+
+## Log Providers ##
+
+### `Rack::Ougai::Logger` ###
+Simple, no-configuration Ougai logger that accepts a `Logger` severity level.
+
+### `Rack::Ougai::ConstantLogger` ###
+Specify a preconfigured logger to be used for all requests. For example, in one project I
+build a global logger, separate from Rack, which is configured via a YAML file; I add it as the
+top level logger in Rack, too.
+
+```
+require 'myproject/log'
+
+use Rack::Ougai::ConstantLogger, MyProject::Log # an instance of Ougai::Logging
+```
+
+## Contributing ##
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rack-ougai. 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.
+
+## License ##
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct ##
+Everyone interacting in the Rack::Ougai project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rack-ougai/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack/ougai"
+
+# 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/ougai/attach_requestid.rb

@@ -0,0 +1,31 @@
+require 'ougai'
+
+module Rack
+  module Ougai
+    class AttachRequestID
+      REQUEST_ID_KEY = 'HTTP_X_REQUEST_ID'
+
+      def initialize(app, opts = {})
+        @app = app
+
+        @storage = opts[:storage] || proc { Thread.current }
+      end
+
+      def call(env)
+        parent = env[Rack::RACK_LOGGER]
+
+        request_id = env[REQUEST_ID_KEY]
+
+        if request_id.nil?
+          parent.warn "No request ID in storage (is Rack::RequestID in your middleware stack?)."
+        end
+
+        env[Rack::RACK_LOGGER] = parent.child(request_id: request_id)
+        ret = @app.call(env)
+        env[Rack::RACK_LOGGER] = parent
+
+        ret
+      end
+    end
+  end
+end

data/lib/rack/ougai/constant_logger.rb

@@ -0,0 +1,19 @@
+require 'ougai'
+
+module Rack
+  module Ougai
+    class ConstantLogger
+      def initialize(app, logger)
+        raise "logger must be an Ougai::Logging (got: #{logger.class.name})." unless logger.is_a?(::Ougai::Logging)
+
+        @app = app
+        @logger = logger
+      end
+
+      def call(env)
+        env[RACK_LOGGER] = @logger
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/rack/ougai/log_requests.rb

@@ -0,0 +1,33 @@
+require 'time'
+
+module Rack
+  module Ougai
+    class LogRequests
+      def initialize(app, logger = nil)
+        @app = app
+        @logger = logger
+      end
+
+      def call(env)
+        status, headers, body = @app.call(env)
+      ensure
+        logger = @logger || env[RACK_LOGGER]
+        logger.info('HTTP Request', create_log(env, status, headers))
+      end
+
+      private
+
+      def create_log(env, status, header)
+        {
+          time: Time.now,
+          remote_addr: env['HTTP_X_FORWARDED_FOR'] || env["REMOTE_ADDR"],
+          method: env[REQUEST_METHOD],
+          path: env[PATH_INFO],
+          query: env[QUERY_STRING],
+          status: status.to_i,
+        }
+      end
+
+    end
+  end
+end

data/lib/rack/ougai/logger.rb

@@ -0,0 +1,20 @@
+require 'ougai'
+
+module Rack
+  module Ougai
+    class Logger
+      def initialize(app, level = ::Logger::INFO)
+        @app = app
+        @level = level
+      end
+
+      def call(env)
+        logger = ::Ougai::Logger.new(env[RACK_ERRORS])
+        logger.level = @level
+
+        env[RACK_LOGGER] = logger
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/rack/ougai/version.rb

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

data/lib/rack/ougai.rb

@@ -0,0 +1,12 @@
+require "rack/ougai/version"
+
+require "rack/ougai/logger"
+require "rack/ougai/constant_logger"
+
+require "rack/ougai/log_requests"
+require "rack/ougai/attach_requestid"
+
+module Rack
+  module Ougai
+  end
+end

data/rack-ougai.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rack/ougai/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-ougai"
+  spec.version       = Rack::Ougai::VERSION
+  spec.authors       = ["Toshimitsu Takahashi", "Ed Ropple"]
+  spec.email         = ["toshi@tilfin.com", "ed@edropple.com"]
+
+  spec.summary       = "Rack integration for the Ougai logger."
+  spec.homepage      = "https://github.com/eropple/rack-ougai"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency "rack", "~> 2.0"
+  spec.add_runtime_dependency "ougai", "~> 1.5"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: rack-ougai
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Toshimitsu Takahashi
+- Ed Ropple
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: ougai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: 
+email:
+- toshi@tilfin.com
+- ed@edropple.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/ougai.rb
+- lib/rack/ougai/attach_requestid.rb
+- lib/rack/ougai/constant_logger.rb
+- lib/rack/ougai/log_requests.rb
+- lib/rack/ougai/logger.rb
+- lib/rack/ougai/version.rb
+- rack-ougai.gemspec
+homepage: https://github.com/eropple/rack-ougai
+licenses:
+- MIT
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Rack integration for the Ougai logger.
+test_files: []