eventhub-components 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cbba5765cb10c12c223815b1934db8b5e1d9e172
+  data.tar.gz: e6b43f9c39845f88e426445f9ef3a80e384f6509
+SHA512:
+  metadata.gz: 8c6e9699a28d8927b8fb25f2b7f49712b13a8d11510c3bfd2bdddf0ab4a100812695b6edcac842472e7784ae48779da1727e313ce3e3d9cae4d3a604ec9f5d82
+  data.tar.gz: 7e74d8599751dc01b6df9e7463fc39a8cc8050105cd39348cdbb2a4a199620ba642e16f31ea3abf5bab8185e3272ee249693c094c20adc44fdbed51f438278b3

data/.gitignore

@@ -0,0 +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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pascal Betz
+
+MIT License
+
+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,38 @@
+# 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

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/eventhub-components.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eventhub/components/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "eventhub-components"
+  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.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec', "~> 3.1.0"
+end

data/lib/eventhub/components.rb

@@ -0,0 +1,8 @@
+module Eventhub
+  module Components
+  end
+end
+
+require_relative "components/version"
+require_relative "components/logger"
+

data/lib/eventhub/components/logger.rb

@@ -0,0 +1,74 @@
+require 'socket'
+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
+  SEVERITY_DEBUG = 7
+  SEVERITY_INFO = 6
+  SEVERITY_WARNING = 4
+  SEVERITY_ERROR = 3
+  SEVERITY_FATAL = 0
+
+  attr_reader :target, :options
+  # Create a new Logger
+  # target: an onject which behaves like a ruby logger.
+  # options (keys are Strings):
+  # * app_name: String, mandatory
+  # * env: String, mandatory
+  # * pid: Number, optional, defaults to Process.pid
+  # * hostname, String, optional, defaults to Socket.gethostname
+  # additional keys are possible and will be sent along. The keys :data and :message are reserved and must not be used.
+  #
+  def initialize(target, options)
+    @target = target
+    @options = options
+    @options['pid'] ||= ::Process.pid
+    @options['hostname'] ||= ::Socket.gethostname
+    verify_options!
+  end
+
+  def debug(message, structured_data = nil)
+    target.debug(build_message(SEVERITY_DEBUG, message, structured_data))
+  end
+
+  def info(message, structured_data = nil)
+    target.info(build_message(SEVERITY_INFO, message, structured_data))
+  end
+
+  def warn(message, structured_data = nil)
+    target.warn(build_message(SEVERITY_WARNING, message, structured_data))
+  end
+
+  def error(message, structured_data = nil)
+    target.error(build_message(SEVERITY_ERROR, message, structured_data))
+  end
+
+  # fatal <=> emergeny <=> alert
+  def fatal(message, structured_data = nil)
+    target.fatal(build_message(SEVERITY_FATAL, message, structured_data))
+  end
+
+  private
+
+  def method_missing(method, *args, &block)
+    target.send(method, *args, &block)
+  end
+
+  def build_message(severity, message, structured_data)
+    options.merge({
+      'severity' => severity,
+      'data' => structured_data,
+      'message' => message
+    })
+  end
+
+  def verify_options!
+    raise ::ArgumentError.new('target must not be nil') if target.nil?
+    raise ::ArgumentError.new('data is a reserved key') if options.has_key?('data')
+    raise ::ArgumentError.new('message is a reserved key') if options.has_key?('message')
+    raise ::ArgumentError.new('app_name is required') if !options['app_name']
+    raise ::ArgumentError.new('env is required') if !options['env']
+  end
+
+end

data/lib/eventhub/components/version.rb

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

data/lib/eventhub/version.rb

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

data/spec/components/logger_spec.rb

@@ -0,0 +1,81 @@
+require_relative '../spec_helper'
+
+RSpec.describe Eventhub::Components::Logger 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')
+      }.to_not raise_error
+    end
+    it 'requires app_name' do
+      expect {
+        Eventhub::Components::Logger.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')
+      }.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')
+      expect(logger.options['pid']).to eq(::Process.pid)
+      expect(logger.options['hostname']).to eq(::Socket.gethostname)
+    end
+  end
+
+  context 'proxy' do
+    let(: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
+      fake_logger
+    end
+    subject {
+      Eventhub::Components::Logger.new(logger, 'app_name' => 'an app', 'env' => 'test')
+    }
+
+    it 'forwards calls to the target when not related to log methods' do
+      expect(subject.class).to eq(logger.class)
+    end
+
+    it 'enriches and forwards debug calls' do
+      subject.debug("my message debug", {'some' => 'debug'})
+      expectation = {'app_name' => 'an app', 'data' => {'some' => 'debug'}, 'env' => 'test', 'hostname' => Socket.gethostname, 'message' => 'my message debug', 'pid' => Process.pid, 'severity' => 7}
+      expect(logger[:debug]).to eq(expectation)
+    end
+
+    it 'enriches and forwards info calls' do
+      subject.info("my message info", {'some' => 'info'})
+      expectation = {'app_name' => 'an app', 'data' => {'some' => 'info'}, 'env' => 'test', 'hostname' => Socket.gethostname, 'message' => 'my message info', 'pid' => Process.pid, 'severity' => 6}
+      expect(logger[:info]).to eq(expectation)
+    end
+
+    it 'enriches and forwards warn calls' do
+      subject.warn("my message warn", {'some' => 'warn'})
+      expectation = {'app_name' => 'an app', 'data' => {'some' => 'warn'}, 'env' => 'test', 'hostname' => Socket.gethostname, 'message' => 'my message warn', 'pid' => Process.pid, 'severity' => 4}
+      expect(logger[:warn]).to eq(expectation)
+    end
+
+    it 'enriches and forwards error calls' do
+      subject.error("my message error", {'some' => 'error'})
+      expectation = {'app_name' => 'an app', 'data' => {'some' => 'error'}, 'env' => 'test', 'hostname' => Socket.gethostname, 'message' => 'my message error', 'pid' => Process.pid, 'severity' => 3}
+      expect(logger[:error]).to eq(expectation)
+    end
+
+    it 'enriches and forwards fatal calls' do
+      subject.fatal("my message fatal", {'some' => 'fatal'})
+      expectation = {'app_name' => 'an app', 'data' => {'some' => 'fatal'}, 'env' => 'test', 'hostname' => Socket.gethostname, 'message' => 'my message fatal', 'pid' => Process.pid, 'severity' => 0}
+      expect(logger[:fatal]).to eq(expectation)
+    end
+
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+Bundler.setup
+require 'rspec'
+require_relative '../lib/eventhub/components'
+
+RSpec.configure do |config|
+  #config.mock_with :rspec
+end
+

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: eventhub-components
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Novartis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Eventhub Components utilities
+email:
+- pascal.betz@simplificator.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- eventhub-components.gemspec
+- lib/eventhub/components.rb
+- lib/eventhub/components/logger.rb
+- lib/eventhub/components/version.rb
+- lib/eventhub/version.rb
+- spec/components/logger_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Eventhub Components utilities
+test_files:
+- spec/components/logger_spec.rb
+- spec/spec_helper.rb