xyeger 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3e103637d758bf273e499346bfbba7ae255126ac
+  data.tar.gz: e09123e3824b1c8613092b91bdf86f5e822111c7
+SHA512:
+  metadata.gz: 8b728fc45afff886a7d0d498e8aa1a85febc4a5d609cd0451cfbb34b2b2d440c613e70d2b073c9aab8b6729fb28b1bd3447a29401220f1968ebb6acb3dfcab68
+  data.tar.gz: 9a254f25e04fa2e463e004d19806f0e38c7660881368669b2f5ba7eab444dc1bb35903e0c5b891ebdb1c70d556d5cd131198a7d7736c71f5d1a13a4637965b94

data/.gitignore

@@ -0,0 +1,2 @@
+.rspec
+.travis.yml

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 vsevolod@cryptopay.me. 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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xyeger.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Avramov Vsevolod
+
+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,110 @@
+# Xyeger
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xyeger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xyeger
+
+## Usage
+
+### Configuration
+
+Add environments:
+```bash
+XYEGER_HOSTNAME='LoggerApplication' #f.e.: rails, sidekiq, sneakers
+```
+
+Add into environment file:
+```ruby
+#config/environments/production.rb
+Rails.application.configure do
+  config.xyeger.enabled = true
+end
+```
+
+## Output results
+
+### Http request
+```bash
+curl localhost:3000 -G -d a=3
+```
+```json
+{
+ "logger": "puma: cluster worker 1: 29117 [cryptopay]",
+ "pid": 29141,
+ "app": "Cryptopay",
+ "env": "development",
+ "level": "INFO",
+ "time": "2017-06-29T15:42:14.761+03:00",
+ "caller": null,
+ "msg": "Lograge message",
+ "context":
+  {"method": "GET",
+   "path": "/",
+   "format": "*/*",
+   "controller": "PagesController",
+   "action": "index",
+   "status": 200,
+   "duration": 1852.79,
+   "view": 703.55,
+   "db": 29.07,
+   "params": {"a": "3"}}
+}
+```
+
+### Raise an error
+```json
+{
+  "logger":"puma",
+  "pid":24886,
+  "app":"Cryptopay",
+  "env":"development",
+  "level":"ERROR",
+  "time":"2017-06-29T15:17:07.736+03:00",
+  "caller":"/home/vsevolod/work/cryptopay/cryptopay/app/services/ticker_service.rb:159",
+  "msg": "StandardError",
+  "context":
+   {
+        "class": "TickerService::TickerNotFound",
+        "error": "Active ticker not found EUR/USD"
+   }
+}
+```
+
+### Manual log usage
+```ruby
+Rails.logger.info('Logger message', { content: '1', params: 'b' })
+```
+```json
+{
+  "logger":"bin/rails",
+  "pid":22796,
+  "app":"Cryptopay",
+  "env":"development",
+  "level":"INFO",
+  "time":"2017-06-30T13:45:22.070+03:00",
+  "caller":null,
+  "message":"Logger message",
+  "context":
+  {
+    "content":"1",
+    "params":"b"
+  }
+}
+
+```
+## 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 "xyeger"
+
+# 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/xyeger/formatters/json.rb

@@ -0,0 +1,38 @@
+module Xyeger
+  module Formatters
+    class Json < ActiveSupport::Logger::SimpleFormatter
+      def call(severity, timestamp, context, message)
+        message, context = prepare(message, context)
+
+        {
+          logger: ENV.fetch('XYEGER_HOSTNAME', $0),
+          pid: $$,
+          app: Rails.application.class.parent_name,
+          env: Rails.env,
+          level: severity,
+          time: timestamp,
+          caller: caller_message(caller_locations),
+          message: message,
+          context: context
+        }.to_json + "\n"
+      end
+
+      def caller_message(callers)
+        if location = callers.find{|x| x.path.include?(Rails.root.to_s)}
+          "#{location.path}:#{location.lineno}"
+        end
+      end
+
+      def prepare(message, context)
+        case message
+        when LogrageRaw
+          ['Lograge', message.data]
+        when ::StandardError
+          ['StandardError', { class: message.class.name, error: message.to_s }]
+        else
+          [message.to_s, context]
+        end
+      end
+    end
+  end
+end

data/lib/xyeger/formatters/lograge_raw.rb

@@ -0,0 +1,6 @@
+module Xyeger
+  module Formatters
+    class LogrageRaw < ActiveSupport::OrderedOptions
+    end
+  end
+end

data/lib/xyeger/formatters.rb

@@ -0,0 +1,8 @@
+module Xyeger
+  module Formatters
+    extend ActiveSupport::Autoload
+
+    autoload :Json
+    autoload :LogrageRaw
+  end
+end

data/lib/xyeger/logger.rb

@@ -0,0 +1,14 @@
+module Xyeger
+  class Logger < ActiveSupport::Logger
+    def initialize(*args)
+      super
+      @formatter = Formatters::Json.new
+    end
+
+    Logger::Severity.constants.each do |severity|
+      define_method "#{severity.downcase}" do |message, context={}|
+        add(Logger::Severity.const_get(severity), message, context)
+      end
+    end
+  end
+end

data/lib/xyeger/railtie.rb

@@ -0,0 +1,15 @@
+require 'rails/railtie'
+require 'action_view/log_subscriber'
+require 'action_controller/log_subscriber'
+
+module Xyeger
+  class Raitie < Rails::Railtie
+    config.xyeger = ActiveSupport::OrderedOptions.new
+    config.xyeger.enabled = false
+    config.xyeger.output = STDOUT
+
+    config.after_initialize do |app|
+      Xyeger.setup(app) if app.config.xyeger.enabled
+    end
+  end
+end

data/lib/xyeger/version.rb

@@ -0,0 +1,3 @@
+module Xyeger
+  VERSION = '0.1.1'.freeze
+end

data/lib/xyeger.rb

@@ -0,0 +1,31 @@
+require 'active_support/logger'
+require 'active_support/dependencies/autoload'
+require 'active_support/ordered_options'
+require "xyeger/version"
+
+module Xyeger
+  module_function
+
+  extend ActiveSupport::Autoload
+
+  autoload :Logger
+  autoload :Formatters
+
+  def setup(app)
+    setup_lograge(app)
+
+    app.config.logger = Logger.new(app.config.xyeger.output)
+    Rails.logger = app.config.logger
+  end
+
+  def setup_lograge(app)
+    app.config.lograge.formatter = -> (data) { Formatters::LogrageRaw.new(data: data) }
+    app.config.lograge.custom_options = lambda do |event|
+      { params: event.payload[:params]&.except('controller', 'action', 'format', 'id') }
+    end
+
+    Lograge.setup(app)
+  end
+end
+
+require 'xyeger/railtie' if defined?(Rails)

data/xyeger.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xyeger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "xyeger"
+  spec.version       = Xyeger::VERSION
+  spec.authors       = ["Avramov Vsevolod"]
+  spec.email         = ["vsevolod@cryptopay.me"]
+
+  spec.summary       = 'Uniq logger for project'
+  spec.description   = 'Uniq logger for project'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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_dependency 'lograge', '>= 0.4'
+  spec.add_runtime_dependency 'activesupport', '>= 4'
+  spec.add_runtime_dependency 'actionpack', '>= 4'
+  spec.add_runtime_dependency 'railties', '>= 4'
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: xyeger
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Avramov Vsevolod
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lograge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: Uniq logger for project
+email:
+- vsevolod@cryptopay.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/xyeger.rb
+- lib/xyeger/formatters.rb
+- lib/xyeger/formatters/json.rb
+- lib/xyeger/formatters/lograge_raw.rb
+- lib/xyeger/logger.rb
+- lib/xyeger/railtie.rb
+- lib/xyeger/version.rb
+- xyeger.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.10
+signing_key: 
+specification_version: 4
+summary: Uniq logger for project
+test_files: []