logiku 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ba08b7dc2d0f67611d145921981348c334749443
+  data.tar.gz: ce4954d51c4200368f2f2da5e74d89f19c997abe
+SHA512:
+  metadata.gz: 9e3f0c4cfe38d297333319d42752641f63b3caf6395e30e39639fe7aa163174c4961d1657f879dbdedfb9cc5016f5c2bd48d7ffe02380a0183bccdb240b923d1
+  data.tar.gz: 08fb9fc820ebdfb8240822af378cdc74802124fbf96121b91d3ab84f11eda7c0503d0166ae9160681da92d523ff1643d8b26301cf46beae29d98fc896dcdef98

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# master
+
+# 0.0.1
+
+* First public versioned release.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in logiku.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 thilonel
+
+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,71 @@
+# Logiku
+[![Build Status](https://travis-ci.org/BookingSync/Logiku.svg?branch=master)](https://travis-ci.org/BookingSync/Logiku)
+
+## Set up
+
+This gem is to be used along with Lograge, so to install add these to your Gemfile:
+
+```ruby
+gem "lograge"
+gem "logiku"
+```
+
+And then execute:
+
+    $ bundle
+
+I recommend having the same log output for test and production environment, so apply the following settings in `config/environments/test.rb` and `production.rb`:
+
+```ruby
+  config.lograge.enabled = true
+  config.lograge.formatter = Logiku::Formatters::KeyValue.new
+  config.logger = ActiveSupport::Logger.new(config.paths["log"].first)
+  config.logger.formatter = Logiku::Normalizers::ActiveSupport.new(Logiku::Formatters::KeyValue.new)
+  config.middleware.delete ActionDispatch::DebugExceptions
+  config.action_mailer.logger = nil
+  config.log_level = :info
+```
+
+And finally let's customize `lograge` a bit, by adding `lograge.rb` to the `initializers`:
+
+```ruby
+Rails.application.configure do
+  config.lograge.custom_options = lambda do |event|
+    additions = { time: event.time }
+
+    filtered_params = event.payload[:params].except("controller", "action", "format", "protocol")
+    additions[:params] = filtered_params.to_json if filtered_params.present?
+
+    additions
+  end
+
+  config.lograge.before_format = lambda do |data, payload|
+    data.except(:format, :controller, :action)
+  end
+end
+```
+
+## Usage
+
+For example if you wish to log `deliver.action_mailer` events, you can do it like this:
+```ruby
+ActiveSupport::Notifications.subscribe "deliver.action_mailer" do |*args|
+  event = ActiveSupport::Notifications::Event.new *args
+
+  data = {
+    event: event.name,
+    subject: event.payload[:subject],
+    to: event.payload[:to].first
+  }
+
+  Rails.logger.info data
+end
+```
+
+What happens here, is that we pass a `Hash` to `Rails.logger.info`. `Logiku::Normalizers::ActiveSupport` will merge that with `severity, time, progname`, call the formatter passed to it: `Logiku::Formatters::KeyValue.new#call` and this will result in a line like this:
+`"severity"="INFO" "time"="2016-12-02T13:17:37.253203Z" "event"="deliver.action_mailer" "subject"="New HomeAway invoice booking" "to"="email_3@domain.com"`
+
+## 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 "logiku"
+
+# 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/logiku/formatters/key_value.rb

@@ -0,0 +1,26 @@
+module Logiku::Formatters
+  class KeyValue
+    def call(data)
+      "#{data.map { |k, v| format k, v }.join(" ")}\n"
+    end
+
+    private
+
+    def format(k, v)
+      %Q{"#{k}"="#{format_value v}"}
+    end
+
+    def format_value(v)
+      case v
+      when String
+        v.gsub(/["\n]/, { '"' => '\"', "\n" => " " })
+      when Hash, Array
+        v.inspect.gsub('"') { %q|\"| }
+      when Time
+        v.utc.iso8601(6)
+      else
+        v.inspect
+      end
+    end
+  end
+end

data/lib/logiku/formatters.rb

@@ -0,0 +1,3 @@
+module Logiku::Formatters
+  autoload :KeyValue, "logiku/formatters/key_value"
+end

data/lib/logiku/normalizers/active_support.rb

@@ -0,0 +1,27 @@
+module Logiku::Normalizers
+  class ActiveSupport
+    def initialize(formatter)
+      @formatter = formatter
+    end
+
+    def call(severity, timestamp, progname, message)
+      if message.kind_of? String
+        message
+      else
+        data = {
+          severity: severity,
+          time: timestamp,
+          progname: progname
+        }
+
+        data.merge! message if message.kind_of? Hash
+
+        formatter.call(data.reject { |_, value| value.nil? })
+      end
+    end
+
+    private
+
+    attr_reader :formatter
+  end
+end

data/lib/logiku/normalizers.rb

@@ -0,0 +1,3 @@
+module Logiku::Normalizers
+  autoload :ActiveSupport, "logiku/normalizers/active_support"
+end

data/lib/logiku/version.rb

@@ -0,0 +1,3 @@
+module Logiku
+  VERSION = "0.0.1"
+end

data/lib/logiku.rb

@@ -0,0 +1,6 @@
+require "logiku/version"
+
+module Logiku
+  autoload :Formatters, "logiku/formatters"
+  autoload :Normalizers, "logiku/normalizers"
+end

data/logiku.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logiku/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "logiku"
+  spec.version       = Logiku::VERSION
+  spec.authors       = ["thilonel"]
+  spec.email         = ["naitodai@gmail.com"]
+
+  spec.summary       = "A log formatter gem."
+  spec.description   = "At BookingSync, we use this to achieve a lean and consistent log output."
+  spec.homepage      = "https://github.com/BookingSync/Logiku"
+  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"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+end

data/travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+ - 2.3

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: logiku
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- thilonel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !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.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: At BookingSync, we use this to achieve a lean and consistent log output.
+email:
+- naitodai@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/logiku.rb
+- lib/logiku/formatters.rb
+- lib/logiku/formatters/key_value.rb
+- lib/logiku/normalizers.rb
+- lib/logiku/normalizers/active_support.rb
+- lib/logiku/version.rb
+- logiku.gemspec
+- travis.yml
+homepage: https://github.com/BookingSync/Logiku
+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.6
+signing_key: 
+specification_version: 4
+summary: A log formatter gem.
+test_files: []
+has_rdoc: