line_log 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 611389b342684afe006c3dcfeb262a30ab7c05d6
+  data.tar.gz: edf202c79a2d06c1efdb56ea98c371c9a3c72c58
+SHA512:
+  metadata.gz: 8e39b9763572ba6072d4763f8f58a8c0c20e6664ff15f679887bade5d3c2cdfde5aac75ceddaa07a7c2f25138c0dd00845ffececcf691f2bcbeb36f7b37d36c9
+  data.tar.gz: c7f7ade086f9257d745eca89c5f68011456a1b2d57136b917115fc40e3a2635ee71c70608046d5b08e0cd826274c7ad5a6b843763c32716136d00b1afe0f6a76

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.1
+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 skillvendor193@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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in LineLog.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Skillvendor
+
+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/LineLog.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'line_log/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "line_log"
+  spec.version       = LineLog::VERSION
+  spec.authors       = ["Skillvendor"]
+  spec.email         = ["skillvendor193@gmail.com"]
+
+  spec.summary       = %q{ custom logger for rack based applications }
+  spec.description   = %q{ LineLog is built to help you have customs logs in Sinatra. LineLog welcomes contribution that would make it better and also any constructive feedback.}
+  spec.homepage      = "https://github.com/Skillvendor/LineLog"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/README.md

@@ -0,0 +1,80 @@
+# LineLog
+
+LineLog is built to help you have customs logs in sinatra(should support any rack application but it is not tested for that).
+
+LineLog welcomes contribution that would make it better and also any constructive feedback.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'line_log'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install line_log
+
+## Usage
+
+  Initialize LineLog with a logger of your choosing.
+
+```
+  configure do
+    #implement custom logging
+    logger = Logger.new("#{RAILS_ROOT}/log/#{settings.environment}.log")
+    use LineLog::Customizer, logger
+  end
+
+```
+  By default the logger will output the method, path, format, ip, status and duration of the request:
+
+```
+  I, [2018-03-15T10:52:52.344791 #188]  INFO -- : method='GET' path='/favicon.ico' format='image/webp,image/apng,image/*,*/*;q=0.8' ip='127.0.0.0' status=404 duration=2.36
+```
+  
+  This can be overwritten by custom data.
+
+
+  To have your own custom data:
+
+  Form a hash with your custom data and pass it to data. The hash will be transformed into a string of key=value pairs separated by a space in the order they were given.
+
+  E.g: Before every action in sinatra add custom data to our request.
+
+```
+  before do
+    LineLog::Customizer.data = {
+      user: '-',
+      params: request.params,
+      agent: request.env['HTTP_USER_AGENT'] || '',
+      protocol: request.scheme,
+      requester: 'John Smith'
+    }
+  end
+  
+```
+
+  The output of this would be:
+```
+  I, [2018-03-15T10:52:52.344791 #188]  INFO -- : method='GET' path='/favicon.ico' format='image/webp,image/apng,image/*,*/*;q=0.8' ip='127.0.0.0' status=404 duration=0.00 user='-' params={} agent='Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/59.0.3071.86 Safari/537.36' protocol='http' requester='John Smith'
+```
+
+## Inner Workings
+
+  LineLog::Customizer exposes a class variable(data) that you can populate with a custom hash. That hash is added to the log by calling the info method of the logger with a string that is formed from the hash given plus the default params explained above.
+
+## Contributing
+
+  Bug reports and pull requests are welcome on GitHub at https://github.com/skillvendor/LineLog. 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](http://opensource.org/licenses/MIT).
+

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 "line_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

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/line_log/customizer.rb

@@ -0,0 +1,24 @@
+module LineLog
+  class Customizer
+    class << self; attr_accessor :formatter, :data end
+
+    def initialize(app, logger=nil, formatter=LineLog::Formatters::KeyValue.new)
+      @app = app
+      @logger = logger
+      self.class.formatter = formatter
+    end
+
+    # making it thread safe. Visit https://github.com/cerner/gc_stats/issues/3 for more info about this
+    def call(event)
+      dup._call(event)
+    end
+
+    def _call(event)
+      began_at = Time.now
+      @status, @headers, @response = @app.call(event)
+
+      message = LineLog::MessageBuilder.new(event, @status, began_at).call
+      LineLog::Writer.call(message, @logger)
+    end
+  end
+end

data/lib/line_log/formatters/key_value.rb

@@ -0,0 +1,27 @@
+module LineLog
+  module Formatters
+    class KeyValue
+      def call(data)
+        data.keys
+          .map { |key| format(key, data[key]) }
+          .join(' ')
+      end
+
+      protected
+
+      def format(key, value)
+        "#{key}=#{parse_value(key, value)}"
+      end
+
+      def parse_value(key, value)
+        # Exactly preserve the previous output
+        # Parsing this can be ambigious if the error messages contains
+        # a single quote
+        return "'#{value}'" if value.is_a? String
+        return Kernel.format('%.2f', value) if value.is_a? Float
+
+        value
+      end
+    end
+  end
+end

data/lib/line_log/message_builder.rb

@@ -0,0 +1,16 @@
+module LineLog
+  class MessageBuilder
+    def initialize(event, status, began_at)
+      @event = event
+      @status = status
+      @began_at = began_at
+    end
+
+    def call
+      data = LineLog::RequestDataExtractor.call(@event, @status, @began_at)
+      formatted_message = LineLog::Customizer.formatter.call(data)
+
+      formatted_message
+    end
+  end
+end

data/lib/line_log/request_data_extractor.rb

@@ -0,0 +1,35 @@
+module LineLog
+  class RequestDataExtractor
+    def self.call(event, status, began_at)
+      extract_data_from_request(event, status, began_at)
+    end
+
+    private
+
+    def self.extract_data_from_request(event, status, began_at)
+      data = default_data(event, status, began_at)
+      data.merge!(custom_data)
+    end
+
+    def self.default_data(event, status, began_at)
+      {
+        method: event['REQUEST_METHOD'],
+        path: extract_path(event),
+        format: event['HTTP_ACCEPT'],
+        ip: event['HTTP_X_REAL_IP'],
+        status: status,
+        duration: (Time.now - began_at).round(2)
+      }
+    end
+
+    def self.extract_path(event)
+      path = event['REQUEST_PATH']
+      index = path.index('?')
+      index ? path[0, index] : path
+    end
+    
+    def self.custom_data
+      LineLog::Customizer.data || {}
+    end
+  end
+end

data/lib/line_log/version.rb

@@ -0,0 +1,3 @@
+module LineLog
+  VERSION = "0.1.0"
+end

data/lib/line_log/writer.rb

@@ -0,0 +1,7 @@
+module LineLog
+  class Writer
+    def self.call(message, logger)
+      logger.info(message)
+    end
+  end
+end

data/lib/line_log.rb

@@ -0,0 +1,9 @@
+require 'line_log/version'
+require 'line_log/writer'
+require 'line_log/request_data_extractor'
+require 'line_log/formatters/key_value'
+require 'line_log/customizer'
+require 'line_log/message_builder'
+
+module LineLog
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: line_log
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Skillvendor
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-15 00:00:00.000000000 Z
+dependencies:
+- !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: " LineLog is built to help you have customs logs in Sinatra. LineLog
+  welcomes contribution that would make it better and also any constructive feedback."
+email:
+- skillvendor193@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- LineLog.gemspec
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/line_log.rb
+- lib/line_log/customizer.rb
+- lib/line_log/formatters/key_value.rb
+- lib/line_log/message_builder.rb
+- lib/line_log/request_data_extractor.rb
+- lib/line_log/version.rb
+- lib/line_log/writer.rb
+homepage: https://github.com/Skillvendor/LineLog
+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.5.2.1
+signing_key: 
+specification_version: 4
+summary: custom logger for rack based applications
+test_files: []