semlogr-rack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8852ad6ae671ebb357fe72a56bb4503a8a81036
+  data.tar.gz: cff7e94ca94b4ad998f358f7798059af089adc35
+SHA512:
+  metadata.gz: e6e584576b47e0092a05db965775d377f2d1df2c7bed1129c0c75a7c56d5f3586a70e280515c0b3a878cb983db32e7db0bbbc7e14445ae8736d7e2d35c668bc7
+  data.tar.gz: 17a6e1be8abe34e7f69d205c0420f432ddcaac789b3243122759162089c64c23147538d790f9e9724929eae5424cd58a60fc0e87beb9deacbe4db5828bc837e4

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,36 @@
+AllCops:
+  TargetRubyVersion: 2.2
+
+Documentation:
+  Enabled: false
+OrderedGems:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# Do not use Rubocop to enforce complexity rules, these will me
+# managed via the PR prorcess to not let in clearly complex code.
+Metrics/ClassLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/BlockNesting:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+### 0.1.0
+
+- Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Semlogr
+
+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,47 @@
+![Codeship Status for semlogr/semlogr-rack](https://codeship.com/projects/dbabb960-15e2-0136-f3e7-6691f5d61ed9/status?branch=master)
+
+# Semlogr integration for Rack
+
+This integration provides some extensions for logging with Rack, currently it provides a request logger
+that logs the details about all requests including timing information.
+
+## Installation
+
+To install:
+
+    gem install semlogr-rack
+
+Or if using bundler, add semlogr to your Gemfile:
+
+    gem 'semlogr-rack'
+
+then:
+
+    bundle install
+
+## Getting Started
+
+Create an instance of the logger and configue the RequestLogger middleware.
+
+```ruby
+require 'semlogr'
+require 'semlogr/rack'
+
+Semlogr.logger = Semlogr.create_logger do |c|
+  c.log_at :info
+
+  c.write_to :console
+end
+
+...
+
+use Semlogr::Rack::RequestLogger
+```
+
+## Development
+
+After cloning the repository run `bundle install` to get up and running, to run the specs just run `rake spec`.
+
+## Contributing
+
+See anything broken or something you would like to improve? feel free to submit an issue or better yet a pull request!

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'semlogr/rack'
+require 'pry'
+
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/semlogr/rack.rb

@@ -0,0 +1,6 @@
+require 'semlogr/rack/request_logger'
+
+module Semlogr
+  module Rack
+  end
+end

data/lib/semlogr/rack/request_logger.rb

@@ -0,0 +1,32 @@
+module Semlogr
+  module Rack
+    class RequestLogger
+      def initialize(app, logger = nil)
+        @app = app
+        @logger = logger
+      end
+
+      def call(env)
+        start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        status, headers, body = @app.call(env)
+        finish = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+        logger.info(
+          'HTTP {method} {path} - {status} ({duration}s)',
+          method: env['REQUEST_METHOD'],
+          path: env['REQUEST_URI'],
+          status: status,
+          duration: (finish - start).round(4)
+        )
+
+        [status, headers, body]
+      end
+
+      private
+
+      def logger
+        @logger || Semlogr.logger
+      end
+    end
+  end
+end

data/lib/semlogr/rack/version.rb

@@ -0,0 +1,5 @@
+module Semlogr
+  module Rack
+    VERSION = '0.1.0'.freeze
+  end
+end

data/semlogr-rack.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'semlogr/rack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'semlogr-rack'
+  spec.version       = Semlogr::Rack::VERSION
+  spec.authors       = ['Stefan Sedich']
+  spec.email         = ['stefan.sedich@gmail.com']
+
+  spec.summary       = 'Semlogr integration for rack.'
+  spec.description   = 'Semlogr integration for rack providing features such as request logging.'
+  spec.homepage      = 'https://github.com/semlogr/semlogr-rack'
+
+  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 'semlogr', '~> 0.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'rubocop', '~> 0.53'
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: semlogr-rack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stefan Sedich
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: semlogr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.53'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.53'
+description: Semlogr integration for rack providing features such as request logging.
+email:
+- stefan.sedich@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/semlogr/rack.rb
+- lib/semlogr/rack/request_logger.rb
+- lib/semlogr/rack/version.rb
+- semlogr-rack.gemspec
+homepage: https://github.com/semlogr/semlogr-rack
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Semlogr integration for rack.
+test_files: []