klogger 1.0.0 → 1.0.1

data/.gitignore

@@ -22,7 +22,11 @@ Jarfile.lock
 Gemfile.lock
 
 # Build directory
-klogger/
+/klogger/
 
 # Config file
 klogger.yml
+
+.DS_Store
+
+.idea

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+
+notifications:
+  email:
+    - killbilling-dev@googlegroups.com
+
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+
+jdk:
+  - openjdk7
+  - oraclejdk7
+  - openjdk6
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head

data/Jarfile

@@ -1,2 +1,3 @@
-jar 'com.ning.billing:killbill-api', '0.1.48'
-jar 'com.ning.billing:killbill-util:tests', '0.1.48'
+jar 'com.ning.billing:killbill-api', '0.1.78'
+jar 'com.ning.billing:killbill-util:tests', '0.1.78'
+jar 'javax.servlet:javax.servlet-api', '3.0.1'

data/README.md

@@ -1,4 +1,43 @@
+[![Build Status](https://travis-ci.org/killbill/killbill-logging-plugin.png)](https://travis-ci.org/killbill/killbill-logging-plugin)
+[![Code Climate](https://codeclimate.com/github/killbill/killbill-logging-plugin.png)](https://codeclimate.com/github/killbill/killbill-logging-plugin)
+
 killbill-logging-plugin
 =======================
 
-Plugin to log Killbill events
+Plugin to log Kill Bill events.
+
+Configuration
+-------------
+
+The plugin expects a `klogger.yml` configuration file containing the following:
+
+```
+syslog:
+  :enabled: true
+  :ident: 'klogger'
+  :options: 9 # ::Syslog::LOG_PID | ::Syslog::LOG_NDELAY
+  :facility: 128 # ::Syslog::LOG_LOCAL0
+
+irc:
+  :enabled: true
+  :channels: ['#killbilling']
+  :nick: 'klogger'
+  :server: 'irc.freenode.org'
+  :port: 6667
+  :password: 'foo'
+
+email:
+  :to: pierre@pierre.com
+  :from: ops@pierre.com
+  :enabled: true
+  :address: 'smtp.gmail.com'
+  :port: 587
+  :domain: 'your.host.name'
+  :username: 'username'
+  :password: 'password'
+  :authentication: 'plain'
+  :enable_starttls_auto: true
+```
+
+By default, the plugin will look at the plugin directory root (where `killbill.properties` is located) to find this file.
+Alternatively, set the Kill Bill system property `-Dcom.ning.billing.osgi.bundles.jruby.conf.dir=/my/directory` to specify another location.

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/klogger.gemspec

@@ -3,16 +3,16 @@ version = File.read(File.expand_path('../VERSION', __FILE__)).strip
 Gem::Specification.new do |s|
   s.name        = 'klogger'
   s.version     = version
-  s.summary     = 'Plugin to log Killbill events.'
-  s.description = 'Log all events generated by Killbill.'
+  s.summary     = 'Plugin to log Kill Bill events.'
+  s.description = 'Log all events generated by Kill Bill.'
 
   s.required_ruby_version = '>= 1.9.3'
 
   s.license = 'Apache License (2.0)'
 
-  s.author   = 'Killbill core team'
+  s.author   = 'Kill Bill core team'
   s.email    = 'killbilling-users@googlegroups.com'
-  s.homepage = 'http://www.killbilling.org'
+  s.homepage = 'http://kill-bill.org'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -22,10 +22,12 @@ Gem::Specification.new do |s|
 
   s.rdoc_options << '--exclude' << '.'
 
-  s.add_dependency 'killbill', '~> 1.0.0'
+  s.add_dependency 'killbill', '~> 1.0.18'
   s.add_dependency 'cinch', '~> 2.0.3'
+  s.add_dependency 'mail', '~> 2.5.3'
 
   s.add_development_dependency 'jbundler', '~> 0.4.1'
   s.add_development_dependency 'rake', '>= 10.0.0'
+  s.add_development_dependency 'rack', '>= 1.5.2'
   s.add_development_dependency 'rspec', '~> 2.12.0'
 end

data/lib/klogger.rb

@@ -4,55 +4,85 @@ require 'psych'
 require 'killbill'
 
 require 'klogger/base'
+require 'klogger/email'
 require 'klogger/irc'
 require 'klogger/syslog'
 
 MODULES = {
             :irc => Klogger::IRC,
-            :syslog => Klogger::Syslog
+            :syslog => Klogger::Syslog,
+            :email => Klogger::Email
           }
 
-ENABLED_MODULES = []
-
-LOG = Logger.new(STDOUT)
-LOG.level = Logger::INFO
-
-# Parse the config file
-begin
-  CONFIG = Psych.load_file('klogger.yml')
-rescue Errno::ENOENT
-  LOG.warn 'Unable to find the config file klogger.yml'
-  CONFIG = {}
-end
-
-# Instantiate each module
-CONFIG.each do |kmodule, config|
-  next unless config['enabled']
-
-  module_klass = MODULES[kmodule.to_sym]
-  next unless module_klass
-
-  LOG.info "Module #{module_klass} enabled"
-  ENABLED_MODULES << module_klass.send('new', config)
-end
-
 # Killbill plugin, which dispatches to all klogger modules
 module Klogger
   class KloggerPlugin < Killbill::Plugin::Notification
 
+    def initialize(*args)
+      super(*args)
+      @enabled_modules = []
+    end
+
     def start_plugin
-      ENABLED_MODULES.each { |m| m.start_plugin rescue nil }
+      configure_modules
+      @enabled_modules.each do |m|
+        begin
+          m.start_plugin
+        rescue => e
+          @logger.warn "Unable to start module #{m.class}: #{e.message}"
+        end
+      end
+
       super
+
+      @logger.info "Klogger::KloggerPlugin started"
     end
 
     def on_event(event)
-      ENABLED_MODULES.each { |m| m.on_event(event) rescue nil }
+      @enabled_modules.each do |m|
+        begin
+          m.on_event(event)
+        rescue => e
+          @logger.warn "Unable to send event to module #{m.class}: #{e.message}"
+        end
+      end
     end
 
     def stop_plugin
       super
-      ENABLED_MODULES.each { |m| m.stop_plugin rescue nil }
+
+      @enabled_modules.each do |m|
+        begin
+          m.stop_plugin
+        rescue => e
+          @logger.warn "Unable to stop module #{m.class}: #{e.message}"
+        end
+      end
+
+      @logger.info "Klogger::KloggerPlugin stopped"
     end
 
+    private
+
+    def configure_modules
+      # Parse the config file
+      begin
+        @config = Psych.load_file("#{@conf_dir}/klogger.yml")
+      rescue Errno::ENOENT
+        @logger.warn "Unable to find the config file #{@conf_dir}/klogger.yml"
+        return
+      end
+
+      # Instantiate each module
+      @config.each do |kmodule, config|
+        next unless config[:enabled]
+
+        module_klass = MODULES[kmodule.to_sym]
+        next unless module_klass
+
+        @logger.info "Module #{module_klass} enabled"
+        @enabled_modules << module_klass.send('new', config, @logger)
+      end
+    end
   end
 end

data/lib/klogger/base.rb

@@ -0,0 +1,20 @@
+module Klogger
+  class KloggerBase
+
+    def initialize(config, logger)
+      @config = config
+      @logger = logger
+    end
+
+    def self.event_to_hash(event)
+      {
+        :event_type => event.event_type,
+        :object_type => event.object_type,
+        :event_id => event.object_id,
+        :account_id => event.account_id,
+        :tenant_id => event.tenant_id
+      }
+    end
+
+  end
+end

data/lib/klogger/email.rb

@@ -0,0 +1,59 @@
+require 'mail'
+
+module Klogger
+  class Email < KloggerBase
+
+    def start_plugin
+      configure
+    end
+
+    def on_event(event)
+      say_event(event)
+    end
+
+    private
+
+    def say_event(event)
+      email_body = <<-eos
+Event type: #{event.event_type}
+Object type: #{event.object_type}
+Account id: #{event.account_id}
+Event id: #{event.object_id}
+Tenant id: #{event.tenant_id}
+eos
+      say(event.event_type, email_body)
+    end
+
+    def say(type, msg)
+      recipient = @config[:to]
+      sender = @config[:from] || "ops@killbill.com"
+      topic = @config[:subject] || "New Kill Bill event: #{type}"
+
+      # Instance variables won't be visible inside the block
+      email = Mail.deliver do
+             to recipient
+           from sender
+        subject topic
+           body msg
+      end
+      @logger.debug "Sent message #{email.message_id} to #{email.to}"
+    end
+
+    def configure
+      options = { :address              => @config[:address],
+                  :port                 => @config[:port],
+                  :domain               => @config[:domain],
+                  :user_name            => @config[:username],
+                  :password             => @config[:password],
+                  :authentication       => @config[:authentication],
+                  :enable_starttls_auto => @config[:enable_starttls_auto] }
+
+
+
+      specified_delivery_method = @config[:delivery_method] || :smtp
+      Mail.defaults do
+        delivery_method specified_delivery_method, options
+      end
+    end
+  end
+end

data/lib/klogger/irc.rb

@@ -0,0 +1,77 @@
+require 'cinch'
+
+module Klogger
+  class IRC < KloggerBase
+
+    def start_plugin
+      @channels = @config[:channels] || ['#killbilling']
+      start_bot(@config[:nick] || 'klogger',
+                @config[:server] || 'irc.freenode.org',
+                @config[:port] || 6667,
+                @config[:password])
+    end
+
+    def on_event(event)
+      @bot.handlers.dispatch(:killbill_events, nil, event, @channels)
+      # Give it some time to write the event to the channel
+      sleep 1
+    end
+
+    def stop_plugin
+      stop_bot
+    end
+
+    private
+
+    class KloggerIRCBot
+      include Cinch::Plugin
+
+      listen_to :killbill_events
+      def listen(m, event, channels)
+        say_event(event, channels)
+      end
+
+      private
+
+      def say_event(event, channels)
+        say(KloggerBase.event_to_hash(event).to_s, channels)
+      end
+
+      def say(msg, channels)
+        channels.each do |chan|
+          Channel(chan).send msg
+        end
+      end
+    end
+
+    def start_bot(nick, server, port, password)
+      connected = false
+      @bot = Cinch::Bot.new do
+        configure do |c|
+          c.nick            = nick
+          c.server          = server
+          c.port            = port
+          c.password        = password
+          c.channels        = @channels
+          c.plugins.plugins = [KloggerIRCBot]
+
+          on :connect do |m|
+            connected = true
+          end
+        end
+      end
+
+      Thread.abort_on_exception = true
+      @bot_thread = Thread.new do
+        @bot.start
+      end
+      sleep 1 until connected
+    end
+
+    def stop_bot
+      @bot.stop
+      Thread.kill(@bot_thread)
+    end
+
+  end
+end

data/lib/klogger/syslog.rb

@@ -0,0 +1,39 @@
+require 'syslog'
+
+module Klogger
+  class Syslog < KloggerBase
+
+    def start_plugin
+      start_syslog(@config[:ident] || 'klogger',
+                   @config[:options] || ::Syslog::LOG_PID | ::Syslog::LOG_NDELAY,
+                   @config[:facility] || ::Syslog::LOG_LOCAL0)
+    end
+
+    def on_event(event)
+      say_event(event)
+    end
+
+    def stop_plugin
+      stop_syslog
+    end
+
+    private
+
+    def say_event(event)
+      say(KloggerBase.event_to_hash(event).to_s)
+    end
+
+    def say(msg)
+      ::Syslog.log(::Syslog::LOG_INFO, msg)
+    end
+
+    def start_syslog(ident, options, facility)
+      ::Syslog.open(ident, options, facility)
+    end
+
+    def stop_syslog
+      ::Syslog.close
+    end
+
+  end
+end

data/pom.xml

@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+~ Copyright 2010-2013 Ning, Inc.
+~
+~  Ning licenses this file to you under the Apache License, version 2.0
+~  (the "License"); you may not use this file except in compliance with the
+~  License.  You may obtain a copy of the License at:
+~
+~     http://www.apache.org/licenses/LICENSE-2.0
+~
+~  Unless required by applicable law or agreed to in writing, software
+~  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+~  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+~  License for the specific language governing permissions and limitations
+~  under the License.
+-->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <groupId>org.sonatype.oss</groupId>
+        <artifactId>oss-parent</artifactId>
+        <version>5</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>com.ning.killbill.ruby</groupId>
+    <artifactId>logging-plugin</artifactId>
+    <packaging>pom</packaging>
+    <version>1.0.1</version>
+    <name>logging-plugin</name>
+    <url>http://github.com/killbill/killbill-logging-plugin</url>
+    <description>Plugin to log Kill Bill events</description>
+    <licenses>
+        <license>
+            <name>Apache License 2.0</name>
+            <url>http://www.apache.org/licenses/LICENSE-2.0.html</url>
+            <distribution>repo</distribution>
+        </license>
+    </licenses>
+    <scm>
+        <connection>scm:git:git://github.com/killbill/killbill-logging-plugin.git</connection>
+        <url>https://github.com/killbill/killbill-logging-plugin/</url>
+        <developerConnection>scm:git:git@github.com:killbill/killbill-logging-plugin.git</developerConnection>
+    </scm>
+</project>

data/release.sh

@@ -0,0 +1,27 @@
+set -e
+
+VERSION=`grep -E '<version>([0-9]+\.[0-9]+\.[0-9]+)</version>' pom.xml | sed 's/[\t \n]*<version>\(.*\)<\/version>[\t \n]*/\1/'`
+if [ "$VERSION" != "$(cat $PWD/VERSION)" ]; then
+  echo "Unable to release: make sure the versions in pom.xml and VERSION match"
+  exit 1
+fi
+
+echo "Cleaning up"
+rake killbill:clean ; rake build
+
+echo "Pushing the gem to Rubygems"
+rake release
+
+echo "Building artifact"
+rake killbill:package
+
+ARTIFACT="$PWD/pkg/klogger-$VERSION.tar.gz"
+echo "Pushing $ARTIFACT to Maven Central"
+mvn gpg:sign-and-deploy-file \
+    -DgroupId=com.ning.killbill.ruby \
+    -DartifactId=logging-plugin \
+    -Dversion=$VERSION \
+    -Dpackaging=tar.gz \
+    -DrepositoryId=ossrh-releases \
+    -Durl=https://oss.sonatype.org/service/local/staging/deploy/maven2/ \
+    -Dfile=$ARTIFACT

data/spec/klogger/integration_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+class String
+  def to_string
+    self
+  end
+end
+
+class MockEvent
+  def get_event_type
+    'InvoiceCreationEvent'
+  end
+
+  def get_object_type
+    'INVOICE'
+  end
+
+  def get_object_id
+    '1234'
+  end
+
+  def get_account_id
+    '11-22-33'
+  end
+
+  def get_tenant_id
+    '1100-998'
+  end
+end
+
+describe Klogger do
+
+  before(:each) do
+    Dir.mktmpdir do |dir|
+      file = File.new(File.join(dir, 'klogger.yml'), "w+")
+      file.write(<<-eos)
+syslog:
+  :enabled: false
+irc:
+  :enabled: false
+email:
+  :enabled: false
+      eos
+      file.close
+
+      @plugin = Klogger::KloggerPlugin.new
+      @plugin.logger = Logger.new(STDOUT)
+      @plugin.conf_dir = File.dirname(file)
+
+      # Start the plugin here - since the config file will be deleted
+      @plugin.start_plugin
+    end
+  end
+
+  it "should start and stop correctly" do
+    @plugin.on_event MockEvent.new
+    @plugin.stop_plugin
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'bundler'
 require 'klogger'
+require 'logger'
 
 require 'rspec'
 

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: klogger
 version: !ruby/object:Gem::Version
+  version: 1.0.1
   prerelease:
-  version: 1.0.0
 platform: ruby
 authors:
-- Killbill core team
+- Kill Bill core team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-01-30 00:00:00.000000000 Z
+date: 2013-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: killbill
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.0.18
     none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.0.18
     none: false
   prerelease: false
   type: :runtime
@@ -31,29 +31,45 @@ dependencies:
   name: cinch
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.3
     none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.3
     none: false
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: mail
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.3
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.3
+    none: false
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: jbundler
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.1
     none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.1
     none: false
@@ -63,41 +79,58 @@ dependencies:
   name: rake
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 10.0.0
     none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 10.0.0
     none: false
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency
+  name: rack
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+    none: false
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: rspec
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.12.0
     none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.12.0
     none: false
   prerelease: false
   type: :development
-description: Log all events generated by Killbill.
+description: Log all events generated by Kill Bill.
 email: killbilling-users@googlegroups.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Jarfile
 - README.md
@@ -107,41 +140,44 @@ files:
 - klogger.gemspec
 - lib/klogger.rb
 - lib/klogger/base.rb
+- lib/klogger/email.rb
 - lib/klogger/irc.rb
 - lib/klogger/syslog.rb
+- pom.xml
+- release.sh
 - spec/klogger/integration_spec.rb
 - spec/spec_helper.rb
-homepage: http://www.killbilling.org
+homepage: http://kill-bill.org
 licenses:
 - Apache License (2.0)
 post_install_message:
 rdoc_options:
-- --exclude
-- .
+- "--exclude"
+- "."
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
   none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       segments:
       - 0
-      hash: 2
       version: !binary |-
         MA==
+      hash: 2
   none: false
 requirements: []
 rubyforge_project:
 rubygems_version: 1.8.24
 signing_key:
 specification_version: 3
-summary: Plugin to log Killbill events.
+summary: Plugin to log Kill Bill events.
 test_files:
 - spec/klogger/integration_spec.rb
 - spec/spec_helper.rb