sysloggable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 905c341697f07420f3fbba5a5118c0991f058cfc
+  data.tar.gz: 4bbb3c0b63fe1f68250395295dd32a943e776bef
+SHA512:
+  metadata.gz: 78d7e3972c7476aedadec9c6eb5b9c3f4bf1c9bbb35e02307f4068041344ff7eb2a9b3f147383767da8444c5ff47eac3aa1243567287da93fa56350a9293e855
+  data.tar.gz: 5eede3bf94802cb56b478bcf1951d0f2f49c235be7781564e0b9f792b90b12f1e6eaea34985c2b10972c53842ebf714b58fd32464e4e7d9720c6d4c6732a0c8a

data/.drone.yml

@@ -0,0 +1,28 @@
+matrix:
+  include:
+    - DOCKER_RUBY_VERSION: 2.2
+      RUBY_IMAGE_TAG: 2.2-1
+
+    - DOCKER_RUBY_VERSION: 1.9.3
+      RUBY_IMAGE_TAG: 1.9.3-2
+
+build:
+  image: abakpress/dind:1
+  privileged: true
+  volumes:
+    - /home/data/drone/images:/images
+    - /home/data/drone/gems:/bundle
+  environment:
+    - COMPOSE_FILE_EXT=drone
+  commands:
+    - wrapdocker docker -v
+
+    - if [ ! -e /images/ssh-agent.tar ]; then docker pull whilp/ssh-agent; docker save whilp/ssh-agent > /images/ssh-agent.tar; fi
+    - if [ ! -e /images/ruby_$RUBY_IMAGE_TAG.tar ]; then docker pull abakpress/ruby:$RUBY_IMAGE_TAG; docker save abakpress/ruby:$RUBY_IMAGE_TAG > /images/ruby_$RUBY_IMAGE_TAG.tar; fi
+
+    - docker load -i /images/ssh-agent.tar
+    - docker load -i /images/ruby_$RUBY_IMAGE_TAG.tar
+
+    - dip ssh add -T
+    - dip provision
+    - dip rspec

data/.gitignore

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

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--tty
+--format progress
+--order random

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sysloggable.gemspec
+gemspec
+
+if RUBY_VERSION < '2'
+  gem 'json', '< 2.0.0'
+  gem 'dry-container', '= 0.3.4'
+end

data/README.md

@@ -0,0 +1,47 @@
+# Sysloggable
+
+Write your logs to syslog. Message is formatted with options and duration.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sysloggable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sysloggable
+
+## Usage
+
+```ruby
+class FooService
+  include ::Sysloggable::InjectLogger(ident: 'banners_stats')
+
+  def call
+    message = "Heavy operation"
+    logger.info(message, operation: 'dump', counter: counter.id, date: date) do |params|
+      heavy_process!
+    end
+  rescue exception
+    logger.fatal(exception.message, trace: exception.backtrace.join("\n"))
+    raise
+  end
+end
+```
+
+## Development
+
+Install Docker, Docker-Compose and DIP https://github.com/bibendi/dip
+
+```sh
+dip provision
+
+dip rspec
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/dip.yml

@@ -0,0 +1,35 @@
+version: '1'
+
+environment:
+  DOCKER_RUBY_VERSION: 2.2
+  RUBY_IMAGE_TAG: 2.2-1
+  COMPOSE_FILE_EXT: development
+
+compose:
+  files:
+    - docker-compose.yml
+    - docker-compose.${COMPOSE_FILE_EXT}.yml
+
+interaction:
+  sh:
+    service: app
+
+  irb:
+    service: app
+    command: irb
+
+  bundle:
+    service: app
+    command: bundle
+
+  rspec:
+    service: app
+    command: bundle exec rspec
+
+  clean:
+    service: app
+    command: rm -f Gemfile.lock
+
+provision:
+  - docker volume create --name bundler_data
+  - dip bundle install

data/docker-compose.development.yml

@@ -0,0 +1,18 @@
+version: '2'
+
+services:
+  app:
+    volumes:
+      - .:/app
+      - ../:/localgems
+      - ssh-data:/ssh:ro
+      - bundler-data:/bundle
+
+volumes:
+  bundler-data:
+    external:
+      name: bundler_data
+
+  ssh-data:
+    external:
+      name: ssh_data

data/docker-compose.drone.yml

@@ -0,0 +1,14 @@
+version: '2'
+
+services:
+  app:
+    volumes:
+      - .:/app
+      - /bundle:/bundle
+      - ssh-data:/ssh:ro
+
+
+volumes:
+  ssh-data:
+    external:
+      name: ssh_data

data/docker-compose.yml

@@ -0,0 +1,9 @@
+version: '2'
+
+services:
+  app:
+    image: abakpress/ruby:$RUBY_IMAGE_TAG
+    environment:
+      - SSH_AUTH_SOCK=/ssh/auth/sock
+      - BUNDLE_PATH=/bundle/$DOCKER_RUBY_VERSION
+    command: bash

data/lib/sysloggable/container.rb

@@ -0,0 +1,12 @@
+require "dry/container"
+require "syslogger"
+require "sysloggable/logger"
+
+module Sysloggable
+  Container = ::Dry::Container.new
+end
+
+::Sysloggable::Container.namespace('lib') do
+  register 'logger', -> { ::Sysloggable::Logger }
+  register 'syslogger', -> { ::Syslogger }
+end

data/lib/sysloggable/logger.rb

@@ -0,0 +1,67 @@
+module Sysloggable
+  class Logger
+    SEVERITIES = {
+      debug: ::Logger::DEBUG,
+      info: ::Logger::INFO,
+      warn: ::Logger::WARN,
+      error: ::Logger::ERROR,
+      fatal: ::Logger::FATAL,
+      unknown: ::Logger::UNKNOWN
+    }.freeze
+
+    def initialize(options)
+      @options = options
+    end
+
+    SEVERITIES.each do |logger_method, logger_code|
+      define_method logger_method do |*args, &block|
+        add(logger_code, *args, &block)
+      end
+    end
+
+    private
+
+    def logger
+      return @logger if defined?(@logger)
+
+      @logger = Container['lib.syslogger'].new(
+        @options.fetch(:ident),
+        ::Syslog::LOG_PID | ::Syslog::LOG_CONS,
+        ::Syslog::LOG_LOCAL0
+      )
+
+      @logger.level = @options.fetch(:level, ::Logger::INFO)
+      @logger.push_tags(@options[:tags]) if @options[:tags]
+
+      @logger
+    end
+
+    def add(severity, message, params = {})
+      if block_given?
+        beginning = Time.now.utc
+        yield params
+        duration = Time.now.utc - beginning
+      else
+        duration = 0
+      end
+
+      formated_message = format_message(severity, message, duration, params)
+
+      logger.add(severity, formated_message)
+    end
+
+    def format_message(severity, message, duration, params)
+      result = {
+        severity: ::Logger::SEV_LABEL[severity],
+        service: @options.fetch(:service_name, @options.fetch(:ident)),
+        operation: params.delete(:operation),
+        duration: duration,
+        message: message
+      }.merge!(params)
+
+      result.each_with_object(String.new) do |(key, value), memo|
+        memo << " " << "#{key}=#{value}"
+      end.strip!
+    end
+  end
+end

data/lib/sysloggable/version.rb

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

data/lib/sysloggable.rb

@@ -0,0 +1,12 @@
+require "sysloggable/version"
+require "sysloggable/container"
+
+module Sysloggable
+  def self.InjectLogger(options)
+    Module.new do
+      define_method(:logger) do
+        @logger ||= Container['lib.logger'].new(options)
+      end
+    end
+  end
+end

data/spec/lib/sysloggable/logger_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe Sysloggable::Logger do
+  let(:syslogger) { spy("syslogger") }
+  subject(:logger) { described_class.new(ident: "test_ident") }
+
+  before do
+    Sysloggable::Container.stub('lib.syslogger', syslogger)
+  end
+
+  described_class::SEVERITIES.each do |severity_name, severity_value|
+    it "responds to #{severity_name}" do
+      sev_label = (severity_name == :unknown) ? "ANY" : severity_name.upcase
+
+      expect(syslogger).to receive(:add).
+        with(severity_value, "severity=#{sev_label} service=test_ident operation= duration=0 message=msg")
+
+      logger.send(severity_name, "msg")
+    end
+  end
+
+  it "counts duration" do
+    Timecop.freeze(Time.now.utc)
+
+    expect(syslogger).to receive(:add).
+      with(described_class::SEVERITIES[:info],
+           "severity=INFO service=test_ident operation= duration=10.0 message=msg")
+
+    logger.info("msg") do
+      Timecop.freeze(Time.now.utc + 10)
+    end
+
+    Timecop.return
+  end
+end

data/spec/lib/sysloggable_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe Sysloggable do
+  it "has a version number" do
+    expect(Sysloggable::VERSION).not_to be nil
+  end
+
+  it "defines logger instance method" do
+    klass = Class.new do
+      include Sysloggable::InjectLogger(ident: "test_name")
+    end
+
+    expect(klass.new.logger).to be_a(Sysloggable::Logger)
+  end
+
+  it "defines logger class method" do
+    klass = Class.new do
+      extend Sysloggable::InjectLogger(ident: "test_name")
+    end
+
+    expect(klass.logger).to be_a(Sysloggable::Logger)
+  end
+
+  it "passes an options to logger" do
+    klass = Class.new do
+      include Sysloggable::InjectLogger(ident: "test_name")
+    end
+
+    expect(klass.new.logger.send(:logger).ident).to eq "test_name"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+
+require "simplecov"
+SimpleCov.start do
+  minimum_coverage 95
+end
+
+require "sysloggable"
+require "dry/container/stub"
+require "timecop"
+
+RSpec.configure do |config|
+  config.before { Sysloggable::Container.enable_stubs! }
+  config.after { Sysloggable::Container.unstub }
+end

data/sysloggable.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sysloggable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sysloggable"
+  spec.version       = Sysloggable::VERSION
+  spec.authors       = ["Michail Merkushin"]
+  spec.email         = ["merkushin.m.s@gmail.com"]
+
+  spec.summary       = "The Logger with writing to syslog"
+  spec.description   = "Writes to syslog with user defined params"
+  spec.homepage      = "https://github.com/abak-press/sysloggable"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "syslogger", "~> 1.6"
+  spec.add_runtime_dependency "dry-container", ">= 0.3.4"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "timecop", "~> 0.8"
+  spec.add_development_dependency "simplecov", "~> 0.12"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: sysloggable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michail Merkushin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: syslogger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: dry-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+description: Writes to syslog with user defined params
+email:
+- merkushin.m.s@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".drone.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- dip.yml
+- docker-compose.development.yml
+- docker-compose.drone.yml
+- docker-compose.yml
+- lib/sysloggable.rb
+- lib/sysloggable/container.rb
+- lib/sysloggable/logger.rb
+- lib/sysloggable/version.rb
+- spec/lib/sysloggable/logger_spec.rb
+- spec/lib/sysloggable_spec.rb
+- spec/spec_helper.rb
+- sysloggable.gemspec
+homepage: https://github.com/abak-press/sysloggable
+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.1
+signing_key: 
+specification_version: 4
+summary: The Logger with writing to syslog
+test_files: []