eventhub-components 0.0.1 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbba5765cb10c12c223815b1934db8b5e1d9e172
-  data.tar.gz: e6b43f9c39845f88e426445f9ef3a80e384f6509
+  metadata.gz: 8c415e3a9835a07fecf3e5e28a8fa26d62ee58e1
+  data.tar.gz: 5bea0da5a68f6eb25437d7e48c1dbe5c5c4b32b5
 SHA512:
-  metadata.gz: 8c6e9699a28d8927b8fb25f2b7f49712b13a8d11510c3bfd2bdddf0ab4a100812695b6edcac842472e7784ae48779da1727e313ce3e3d9cae4d3a604ec9f5d82
-  data.tar.gz: 7e74d8599751dc01b6df9e7463fc39a8cc8050105cd39348cdbb2a4a199620ba642e16f31ea3abf5bab8185e3272ee249693c094c20adc44fdbed51f438278b3
+  metadata.gz: a0a2bcd8140e494793dcda886ede62a0ff4a3f8ccc6035042233cb046362a4546d8dc338b44131383db3df8e394a39bb932b39921d028be45b261e855895c090
+  data.tar.gz: 1a154f6db1b991d178f7f31a7de78979666447ef9541649d9faffb91a58eedeeb921eec4fdd267426ca00bc096804bcbcf161c011319c9310a21c37ac14743bf

data/.gitignore

@@ -1,17 +1,17 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/README.md

@@ -1,38 +1,73 @@
-# Eventhub::Components
-
-TODO: Write a gem description
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'eventhub-components'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install eventhub-components
-
-## Usage
-
-This Gem provides shared code for processors and the console app.
-
-### Logger
-
-Provides a second argument (a hash) to the log methods (debug, info, ...)
-
-''''
-logger = Eventhub::Components::Logger.new(some_other_logger, 'app_name' => 'my fancy app', 'env' => 'staging')
-logger.info("my message", :foo => 1, :bar => 2)
-''''
-
-## Contributing
-
-1. Fork it ( https://github.com/[my-github-username]/eventhub-components/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+# EventHub::Components
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'eventhub-components'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eventhub-components
+
+## Usage
+
+This Gem provides shared code for processors and the console app.
+
+### Pid Files
+
+Takes care of writing, reading and deleting a PID file
+
+    pid_file = EventHub::Components::PidFile.new('my_application.pid')
+    pid_file.write # writes Process.pid
+    # or
+    pid_file.write(some_process_pid)
+
+    pid_file.read # => "some_pid" (it's a string as it comes from a file)
+
+    pid_file.delete
+
+
+### Logging
+
+#### StructuredDataLogger
+
+Provides a second argument (a hash) to the log methods (debug, info, ...)
+
+    logger = EventHub::Components::StructuredDataLogger.new(some_other_logger, 'app_name' => 'my fancy app', 'env' => 'staging')
+    logger.info("my message", :foo => 1, :bar => 2)
+
+
+#### MultiLogger
+
+Forwards calls to all devices that have been added to the multilogger.
+
+    logger = EventHub::Components::MultiLogger.new
+    logger.add_device(some_other_logger_1)
+    logger.add_device(some_other_logger_2)
+    logger.info("Hans")
+
+#### ExceptionWriter
+
+Helps writing exceptions and log messages to files. It creates
+
+    writer = EventHub::Components::ExceptionWriter.new() # logs to ./exceptions
+    # or
+    writer = EventHub::Components::ExceptionWriter.new('some_dir', max_number_of_files) # logs to ./exceptions/some_dir
+
+    writer.write(e)
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/eventhub-components/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/eventhub-components.gemspec

@@ -5,11 +5,11 @@ require 'eventhub/components/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "eventhub-components"
-  spec.version       = Eventhub::Components::VERSION
+  spec.version       = EventHub::Components::VERSION
   spec.authors       = ["Novartis"]
   spec.email         = ["pascal.betz@simplificator.com"]
-  spec.summary       = %q{Eventhub Components utilities}
-  spec.description   = %q{Eventhub Components utilities}
+  spec.summary       = %q{EventHub Components utilities}
+  spec.description   = %q{EventHub Components utilities}
   spec.homepage      = ""
   spec.license       = "MIT"
 

data/lib/eventhub/components/exception_writer.rb

@@ -0,0 +1,62 @@
+class EventHub::Components::ExceptionWriter
+
+  MAX_EXCEPTIONS_FILES = 500
+
+  attr_accessor :folder, :max_files
+
+  def initialize(base = nil, max_files = MAX_EXCEPTIONS_FILES)
+      base = base ||= Dir.pwd
+      @folder = File.join(base, 'exceptions')
+      @max_files = max_files
+      FileUtils.makedirs(folder)
+  end
+
+
+  def write(exception, message = nil)
+    time = Time.now
+    stamp = "#{time.strftime("%Y%m%d_%H%M%S")}_%i" % time.usec
+
+    write_exception("#{stamp}.log", exception)
+    write_message("#{stamp}.msg.raw", message)
+
+    restrict_to_max_files
+
+    stamp
+  end
+
+
+  private
+
+  def restrict_to_max_files
+    exception_files = Dir.glob(File.join(folder, '*.log'))
+    if exception_files.size > max_files
+      exception_files.reverse[max_files..-1].each do |file|
+        begin
+          File.delete(file)
+          raw = File.join(File.dirname(file), File.basename(file, ".*"), '.msg.raw')
+          File.delete(raw)
+        rescue
+        end
+      end
+    end
+  end
+
+  def write_exception(filename, exception)
+    File.open("#{folder}/#{filename}", "w") do |output|
+      output.write("#{exception}\n\n")
+      output.write("Exception: #{exception.class.to_s}\n\n")
+      output.write("Call Stack:\n")
+      exception.backtrace.each do |line|
+        output.write("#{line}\n")
+      end if exception.backtrace
+    end
+  end
+
+  def write_message(filename, message)
+    return unless message
+    File.open("#{folder}/#{filename}","wb") do |output|
+      output.write(message)
+    end
+  end
+
+end

data/lib/eventhub/components/log_formatter.rb

@@ -0,0 +1,7 @@
+# format adaptation
+class EventHub::Components::LogFormatter
+  def call(severity, time, progname, msg)
+    time_in_string = "#{time.strftime("%Y-%m-%d %H:%M:%S")}.#{"%04d" % (time.usec/100)}"
+    [time_in_string, Process.pid, severity, msg].join("\t") + "\n"
+  end
+end

data/lib/eventhub/components/multi_logger.rb

@@ -0,0 +1,28 @@
+class EventHub::Components::MultiLogger < BasicObject
+
+  attr_accessor :devices
+
+  def initialize(folder=nil)
+    @devices = []
+  end
+
+  def add_device(device)
+    ::Kernel.raise ::ArgumentError.new("can not add nil device") if device.nil?
+    @devices << device
+    self
+  end
+
+
+  private
+
+  def method_missing(method, *args, &block)
+    devices.map do |target|
+      begin
+        target.send(method, *args, &block)
+      rescue => e
+        ::STDERR.puts "WARNING: Could not call #{method} in #{target} with #{args} because of #{e.message}"
+        e
+      end
+    end
+  end
+end

data/lib/eventhub/components/pid_file.rb

@@ -0,0 +1,31 @@
+class EventHub::Components::Pidfile
+  attr_reader :file_name
+  def initialize(file_name)
+    @file_name = file_name
+  end
+
+  # write the pid to the file specified in the initializer
+  # defaults to Process.pid
+  def write(pid = Process.pid)
+    FileUtils.makedirs(File.dirname(file_name))
+    IO.write(file_name, pid.to_s)
+  end
+
+  # Try to delete file, ignore all errors
+  def delete
+    begin
+      File.delete(file_name)
+    rescue
+      # ignore
+    end
+  end
+
+  # Read the PID from the file
+  def read
+    begin
+      File.read(file_name)
+    rescue Errno::ENOENT => e
+      # ignore, will return nil
+    end
+  end
+end

data/lib/eventhub/components/{logger.rb → structured_data_logger.rb}

@@ -3,7 +3,7 @@ require 'thread'
 
 # A wrapper for loggers to enrich the log message with structured data (a Hash).
 # All methods besides debug/info/warn/error/fatal are forwarded to the target by the means of method_missing.
-class Eventhub::Components::Logger < BasicObject
+class EventHub::Components::StructuredDataLogger < BasicObject
   SEVERITY_DEBUG = 7
   SEVERITY_INFO = 6
   SEVERITY_WARNING = 4

data/lib/eventhub/components/version.rb

@@ -1,5 +1,5 @@
-module Eventhub
+module EventHub
   module Components
-    VERSION = "0.0.1"
+    VERSION = '0.0.5'
   end
 end

data/lib/eventhub/components.rb

@@ -1,8 +1,14 @@
-module Eventhub
+module EventHub
   module Components
   end
 end
 
+require 'fileutils'
+require 'logger'
 require_relative "components/version"
-require_relative "components/logger"
+require_relative "components/log_formatter"
+require_relative "components/multi_logger"
+require_relative "components/structured_data_logger"
+require_relative "components/exception_writer"
+require_relative "components/pid_file"
 

data/spec/components/exception_writer_spec.rb

@@ -0,0 +1,54 @@
+require_relative '../spec_helper'
+
+RSpec.describe EventHub::Components::StructuredDataLogger do
+  context 'logger' do
+
+    before(:each) do
+      remove_all_exception_files
+    end
+
+    after(:each) do
+      remove_all_exception_files
+    end
+
+    let(:writer) {
+      EventHub::Components::ExceptionWriter.new('tmp', 5)
+    }
+
+    it 'writes an exception' do
+      begin
+        raise
+      rescue => e
+        name = writer.write(e)
+      end
+      expect(Dir['tmp/exceptions/*'].size).to eq(1)
+    end
+
+    it 'writes an exception and a message' do
+      begin
+        raise
+      rescue => e
+        name = writer.write(e, "hi")
+      end
+      expect(Dir['tmp/exceptions/*'].size).to eq(2)
+    end
+
+    it 'limits number of files' do
+      begin
+        raise
+      rescue => e
+        (writer.max_files + 1).times do
+          writer.write(e)
+        end
+      end
+      expect(Dir['tmp/exceptions/*'].size).to eq(5)
+    end
+
+  end
+
+  def remove_all_exception_files
+    Dir['tmp/exceptions/*'].each do |file|
+      File.delete(file)
+    end
+  end
+end

data/spec/components/multi_logger_spec.rb

@@ -0,0 +1,47 @@
+require_relative '../spec_helper'
+
+RSpec.describe EventHub::Components::StructuredDataLogger do
+  context 'logger' do
+
+    let(:logger) {
+      EventHub::Components::MultiLogger.new
+    }
+
+
+    # it 'forwards calls to ALL devices' do
+    #   device_1 = stub(:device_1)
+    #   expect(device_1).to receive(:info).and_return(1)
+    #   device_2 = stub(:device_2)
+    #   expect(device_2).to receive(:info).and_return(2)
+
+    #   logger.add_device(device_1)
+    #   logger.add_device(device_2)
+
+    #   result = logger.info("hans")
+    #   expect(result).to eq([1, 2])
+    # end
+
+
+    # it 'forwards calls to ALL devices even if one raises' do
+    #   device_1 = stub(:device_1)
+    #   expect(device_1).to receive(:info).and_raise
+    #   device_2 = stub(:device_2)
+    #   expect(device_2).to receive(:info).and_return(2)
+
+    #   logger.add_device(device_1)
+    #   logger.add_device(device_2)
+
+    #   result = logger.info("hans")
+    # end
+
+    # it 'returns self after adding device' do
+    #   expect(logger.add_device("something")).to eq(logger)
+    # end
+
+    it 'does not allow nil as device' do
+      expect {
+        logger.add_device nil
+      }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/components/pid_file_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'fileutils'
+
+describe EventHub::Components::Pidfile do
+  before(:each) do
+    FileUtils.remove_dir('/tmp/eventhub_pid_test', true)
+  end
+
+  after(:each) do
+    FileUtils.remove_dir('/tmp/eventhub_pid_test', true)
+  end
+
+  let(:pidfile) {  pidfile = EventHub::Components::Pidfile.new('/tmp/eventhub_pid_test/some.pid') }
+
+  it 'creates the folders if not existing' do
+    pidfile.write(1234)
+    expect(File.directory?('/tmp/eventhub_pid_test')).to be true
+  end
+
+  it 'writes the content to the file' do
+    pidfile.write(1234)
+    expect(IO.read('/tmp/eventhub_pid_test/some.pid')).to eq('1234')
+  end
+
+  it 'deletes the file' do
+    pidfile.write(1234)
+    pidfile.delete
+    expect(File.file?('/tmp/eventhub_pid_test/some.pid')).to be false
+  end
+
+  it 'does not choke when deleting a non-existing pid file' do
+    pidfile.delete
+  end
+
+  it 'does not choke when reading a non-existing pid file' do
+    expect(pidfile.read).to eq(nil)
+  end
+
+  it 'reads the pid written to the file' do
+    pidfile.write(1234)
+    expect(pidfile.read).to eq("1234")
+  end
+
+  it 'it writes the currents process pid as default' do
+    pidfile.write
+    expect(pidfile.read).to eq(Process.pid.to_s)
+  end
+end

data/spec/components/{logger_spec.rb → structured_data_logger_spec.rb}

@@ -1,25 +1,25 @@
 require_relative '../spec_helper'
 
-RSpec.describe Eventhub::Components::Logger do
+RSpec.describe EventHub::Components::StructuredDataLogger do
   context 'initalize' do
     it 'no raise when all required arguments are given' do
       expect {
-        Eventhub::Components::Logger.new("something not nil", 'app_name' => 'an app', 'env' => 'test')
+        EventHub::Components::StructuredDataLogger.new("something not nil", 'app_name' => 'an app', 'env' => 'test')
       }.to_not raise_error
     end
     it 'requires app_name' do
       expect {
-        Eventhub::Components::Logger.new("something not nil", 'env' => 'test')
+        EventHub::Components::StructuredDataLogger.new("something not nil", 'env' => 'test')
       }.to raise_error(ArgumentError)
     end
     it 'requires app_name' do
       expect {
-        Eventhub::Components::Logger.new("something not nil", 'app_name' => 'an app')
+        EventHub::Components::StructuredDataLogger.new("something not nil", 'app_name' => 'an app')
       }.to raise_error(ArgumentError)
     end
 
     it 'adds the default options' do
-      logger = Eventhub::Components::Logger.new("something not nil", 'app_name' => 'an app', 'env' => 'test')
+      logger = EventHub::Components::StructuredDataLogger.new("something not nil", 'app_name' => 'an app', 'env' => 'test')
       expect(logger.options['pid']).to eq(::Process.pid)
       expect(logger.options['hostname']).to eq(::Socket.gethostname)
     end
@@ -30,15 +30,15 @@ RSpec.describe Eventhub::Components::Logger do
       # fake logger that stores a log message
       # in hash
       fake_logger = Hash.new
-      def l.debug(message); self[:debug] = message; end
-      def l.info(message); self[:info] = message; end
-      def l.warn(message); self[:warn] = message; end
-      def l.error(message); self[:error] = message; end
-      def l.fatal(message); self[:fatal] = message; end
+      def fake_logger.debug(message); self[:debug] = message; end
+      def fake_logger.info(message); self[:info] = message; end
+      def fake_logger.warn(message); self[:warn] = message; end
+      def fake_logger.error(message); self[:error] = message; end
+      def fake_logger.fatal(message); self[:fatal] = message; end
       fake_logger
     end
     subject {
-      Eventhub::Components::Logger.new(logger, 'app_name' => 'an app', 'env' => 'test')
+      EventHub::Components::StructuredDataLogger.new(logger, 'app_name' => 'an app', 'env' => 'test')
     }
 
     it 'forwards calls to the target when not related to log methods' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eventhub-components
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.5
 platform: ruby
 authors:
 - Novartis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-07 00:00:00.000000000 Z
+date: 2014-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.0
-description: Eventhub Components utilities
+description: EventHub Components utilities
 email:
 - pascal.betz@simplificator.com
 executables: []
@@ -66,10 +66,16 @@ files:
 - Rakefile
 - eventhub-components.gemspec
 - lib/eventhub/components.rb
-- lib/eventhub/components/logger.rb
+- lib/eventhub/components/exception_writer.rb
+- lib/eventhub/components/log_formatter.rb
+- lib/eventhub/components/multi_logger.rb
+- lib/eventhub/components/pid_file.rb
+- lib/eventhub/components/structured_data_logger.rb
 - lib/eventhub/components/version.rb
-- lib/eventhub/version.rb
-- spec/components/logger_spec.rb
+- spec/components/exception_writer_spec.rb
+- spec/components/multi_logger_spec.rb
+- spec/components/pid_file_spec.rb
+- spec/components/structured_data_logger_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -94,7 +100,11 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Eventhub Components utilities
+summary: EventHub Components utilities
 test_files:
-- spec/components/logger_spec.rb
+- spec/components/exception_writer_spec.rb
+- spec/components/multi_logger_spec.rb
+- spec/components/pid_file_spec.rb
+- spec/components/structured_data_logger_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/lib/eventhub/version.rb

@@ -1,5 +0,0 @@
-module Eventhub
-  module Components
-    VERSION = "0.0.1"
-  end
-end