rack-commonlogger 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5bdcd1f39f69551ac79ace49c6185f25845e3923
+  data.tar.gz: 4d1782eda0d67ce0705584f1dcec75490d5bb1b7
+SHA512:
+  metadata.gz: 2529cb7b0525536e74b9ed1ef33ff5bbb37e838abec9f348ba796e777baaf2f7d5a4b23c01be13c01d016e773563602af5904248462512f48421165200d97a6b
+  data.tar.gz: 110beaaa8862dd4c990046f126b20ee99052f965ab500d8ff7a39c267ca8dfb909c1e1b182474b5a4464962ff1e3eb02e61b9e9c38acfb1cd0001121f23bc48b

data/lib/rack-commonlogger.rb

@@ -0,0 +1,3 @@
+module Rack
+  require_relative "rack/commonlogger"
+end

data/lib/rack/commonlogger.rb

@@ -0,0 +1,71 @@
+module Rack
+  # Rack::CommonLogger forwards every request to the given +app+, and
+  # logs a line in the
+  # {Apache common log format}[http://httpd.apache.org/docs/1.3/logs.html#common]
+  # to the +logger+.
+  #
+  # If +logger+ is nil, CommonLogger will fall back +rack.errors+, which is
+  # an instance of Rack::NullLogger.
+  #
+  # +logger+ can be any class, including the standard library Logger, and is
+  # expected to have either +write+ or +<<+ method, which accepts the CommonLogger::FORMAT.
+  # According to the SPEC, the error stream must also respond to +puts+
+  # (which takes a single argument that responds to +to_s+), and +flush+
+  # (which is called without arguments in order to make the error appear for
+  # sure)
+  module CommonLogger
+    require_relative "commonlogger/version"
+    # Common Log Format: http://httpd.apache.org/docs/1.3/logs.html#common
+    #
+    #   lilith.local - - [07/Aug/2006 23:58:02 -0400] "GET / HTTP/1.1" 500 -
+    #
+    #   %{%s - %s [%s] "%s %s%s %s" %d %s\n} %
+    FORMAT = %{%s - %s [%s] "%s %s%s %s" %d %s %0.4f\n}
+
+    def initialize(app, logger = nil)
+      @app = app
+      @logger = logger
+    end
+
+    def call(env)
+      began_at = Time.now
+      status, header, body = @app.call(env)
+      header = Utils::HeaderHash.new(header)
+      body = BodyProxy.new(body) { log(env, status, header, began_at) }
+      [status, header, body]
+    end
+
+    private
+
+    def log(env, status, header, began_at)
+      now = Time.now
+      length = extract_content_length(header)
+
+      msg = FORMAT % [
+        env['HTTP_X_FORWARDED_FOR'] || env["REMOTE_ADDR"] || "-",
+        env["REMOTE_USER"] || "-",
+        now.strftime("%d/%b/%Y:%H:%M:%S %z"),
+        env[REQUEST_METHOD],
+        env[PATH_INFO],
+        env[QUERY_STRING].empty? ? "" : "?"+env[QUERY_STRING],
+        env["HTTP_VERSION"],
+        status.to_s[0..3],
+        length,
+        now - began_at ]
+
+      logger = @logger || env['rack.errors']
+      # Standard library logger doesn't support write but it supports << which actually
+      # calls to write on the log device without formatting
+      if logger.respond_to?(:write)
+        logger.write(msg)
+      else
+        logger << msg
+      end
+    end
+
+    def extract_content_length(headers)
+      value = headers[CONTENT_LENGTH] or return '-'
+      value.to_s == '0' ? '-' : value
+    end
+  end
+end

data/lib/rack/commonlogger/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module CommonLogger
+    VERSION = "1.0.0"
+  end
+end

data/spec/lib/rack/commonlogger.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+describe Rack::CommonLogger do
+  let(:application) { instance_double("Application") }
+  let(:middleware) { described_class.new(application) }
+  let(:verb) { "GET" }
+  let(:status) { 200 }
+  let(:headers) do
+    {
+      "REQUEST_METHOD" => verb,
+      "Content-Type" => "text/plain",
+      "Content-Length" => "0"
+    }
+  end
+  let(:body) { "" }
+
+  before(:each) do
+    allow(application).to receive(:call).and_return([status, headers, body])
+  end
+
+  describe "#call" do
+
+  end
+end

data/spec/lib/rack/commonlogger/version_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe Rack::CommonLogger::VERSION do
+  it "should be a string" do
+    expect(Rack::CommonLogger::VERSION).to be_kind_of(String)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require "pry"
+require "rspec"
+require "rack/commonlogger"

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: rack-commonlogger
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kurtis Rainbolt-Greene
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: Writes commonlogger to responses
+email:
+- me@kurtisrainboltgreene.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rack-commonlogger.rb
+- lib/rack/commonlogger.rb
+- lib/rack/commonlogger/version.rb
+- spec/lib/rack/commonlogger.rb
+- spec/lib/rack/commonlogger/version_spec.rb
+- spec/spec_helper.rb
+homepage: http://krainboltgreene.github.io/rack-commonlogger
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Writes commonlogger to responses
+test_files:
+- spec/lib/rack/commonlogger/version_spec.rb
+- spec/lib/rack/commonlogger.rb
+- spec/spec_helper.rb
+has_rdoc: