logstash_rails 0.0.7 → 0.0.8

data/.rspec

@@ -0,0 +1,5 @@
+--require spec_helper
+--order random
+--colour
+--format nested
+-b

data/Gemfile

@@ -10,7 +10,6 @@ group :development do
 end
 
 group :test do
-  gem 'minitest', require: 'minitest/autorun'
+  gem 'rspec'
   gem 'fakeredis'
-  gem 'mocha', require: false
 end

data/README.md

@@ -1,49 +1,86 @@
-# LogstashRails [![Code Climate](https://codeclimate.com/github/cmertz/logstash_rails.png)](https://codeclimate.com/github/cmertz/logstash_rails) [![Build Status](https://secure.travis-ci.org/cmertz/logstash_rails.png)](http://travis-ci.org/cmertz/logstash_rails) [![Dependency Status](https://gemnasium.com/cmertz/logstash_rails.png)](https://gemnasium.com/cmertz/logstash_rails) [![Coverage Status](https://coveralls.io/repos/cmertz/logstash_rails/badge.png)](https://coveralls.io/r/cmertz/logstash_rails)
+# LogstashRails 
+[![Gem Version](https://badge.fury.io/rb/logstash_rails.png)](http://badge.fury.io/rb/logstash_rails)
+[![Build Status](https://secure.travis-ci.org/cmertz/logstash_rails.png)](http://travis-ci.org/cmertz/logstash_rails)
+[![Coverage Status](https://coveralls.io/repos/cmertz/logstash_rails/badge.png)](https://coveralls.io/r/cmertz/logstash_rails)
+[![Code Climate](https://codeclimate.com/github/cmertz/logstash_rails.png)](https://codeclimate.com/github/cmertz/logstash_rails)
+[![Dependency Status](https://gemnasium.com/cmertz/logstash_rails.png)](https://gemnasium.com/cmertz/logstash_rails)
 
-Send Logstash events from a Rails application to Redis.
+Send events from Rails to Logstash without logger foo.
 
-## Installation
+## Contents
 
-In your applications Gemfile:
+* [Usage](#usage)
+    * [Configuration](#configurtion)
+    * [Examples](#examples)
+* [Contributing](#contributing)
 
-```ruby
-gem 'logstash_rails'
-```
 
-For the latest version:
+## Usage
+
+Add logstash-rails to your applications `Gemfile`
 
 ```ruby
-gem 'logstash_rails', github: 'cmertz/logstash_rails'
+gem 'logstash_rails'
 ```
 
-Provide an initializer (e.g. config/initializers/logstash_rails.rb) for
-specific configuration.
+and provide an initializer for configuration.
+
 
 ### Configuration
 
-**LogstashRails.config** takes a redis connection, the redis key for the list
-to push to and a flag that enables to catch all events (i.e. /.\*/)
+`LogstashRails.config` takes an options hash with the following options:
+
+* __transport__
+  
+  redis is the only available transport atm
+
+* __logger__
+  
+  logger to use in case of exceptions while pushing events to the transport
+
+* __events__
+
+  list of event name patterns to subscribe to. `Regex` and `String` is
+  supported.
+  
+* __transport options__
+
+  transport specific options e.g. _host_, _port_ and *redis_key*
+
+
+### Examples
 
 The most basic configuration looks like:
 
 ```ruby
-LogstashRails.config(Redis.new)
+LogstashRails.config(transport: :redis)
 ```
 
-This will connect to the redis server on localhost, use 'logstash' (default) as
-key for the redis list to push to and subscribe to all events.
+This will will connect to a redis server on _localhost:6379_, use _logstash_ as
+key for the redis list to push to and subscribe to _all events_.
 
 A more complete example looks like:
 
 ```ruby
 if Rails.env.production?
-  redis = Redis.new(host: '1.2.3.4', port: 12345)
-  LogstashRails.config(redis, 'my_key', false)
-  LogstashRails.subscribe('process_action.action_controller')
+  LogstashRails.config(
+    transport: redis,
+    host: '1.2.3.4', 
+    port: 12345,
+    redis_key: 'my_key',
+    events: [/action_controller/]
+  )
 end
 ```
 
+This will only subscribe to events from `ActionController`.
+
 
-## TODO
+## Contributing
 
-* more independent from Rails i.e. check defined?(Rails) and provide fallbacks (for logger and application name)
+1. Fork it.
+2. Create a branch (`git checkout -b my_feature`)
+3. Commit your changes (`git commit -am "Added ..."`)
+4. Push to the branch (`git push origin my_feature`)
+5. Open a Pull Request
+6. Enjoy a refreshing Diet Coke and wait

data/Rakefile

@@ -1,13 +1,8 @@
 require 'bundler/gem_tasks'
-require 'rake/testtask'
 require 'yard/rake/yardoc_task'
+require 'rspec/core/rake_task'
 
-Rake::TestTask.new do |t|
-  t.libs.push "lib"
-  t.libs.push "spec"
-  t.test_files = FileList['spec/*_spec.rb']
-  t.verbose = false
-end
+RSpec::Core::RakeTask.new(:test)
 
 YARD::Rake::YardocTask.new do |t|
   t.name = 'doc'

data/lib/logstash_rails.rb

@@ -1,64 +1,20 @@
-require 'logstash_rails/formatter'
 require 'active_support'
+require 'active_support/core_ext/string'
 
-module LogstashRails
-  class << self
-
-    # configures LogstashRails
-    #
-    # @param redis
-    # @param key [String]
-    # @param handle_all [Boolean]
-    #
-    def config(redis, key = 'logstash', handle_all = true)
-      unless handle_all.is_a?(TrueClass) || handle_all.is_a?(FalseClass)
-        raise ArgumentError
-      end
-
-      raise ArgumentError unless key.is_a?(String)
-
-      raise ArgumentError unless redis
-
-      @redis = redis
-      @key   = key
-
-      subscribe(/.*/) if handle_all
-    end
+require 'logstash_rails/configuration_base'
 
-    # subscribes LogstashRails to an ActiveSupport notification
-    #
-    # @param event_type [String|Regexp]
-    #
-    def subscribe(event_type)
-      @subscriptions ||= {}
-
-      @subscriptions[event_type] = ActiveSupport::Notifications.subscribe(event_type) do |*args|
-        push(*args)
-      end
-    end
-
-    # unsubscribe LogstashRails form an ActiveSupport notification
-    #
-    # @param event_type [String|Regexp] this must be the equal to the event_type that was subscribed with
-    #
-    def unsubscribe(event_type)
-      ActiveSupport::Notifications.unsubscribe(@subscriptions[event_type])
-    end
-
-    private
+Dir[File.join(File.dirname(__FILE__), 'logstash_rails', '*.rb')].each do |file|
+  require file
+end
 
-    def push(event_type, *args)
-      begin
-        @redis.rpush(@key, Formatter.format(event_type, *args))
-      rescue
-        log $!
-      end
-    end
+module LogstashRails
+  extend self
 
-    def log(exception)
-      msg = exception.message + "\n " + exception.backtrace.join("\n ")
-      Rails.logger.error(msg)
-    end
+  def config(options)
+    transport = options.fetch(:transport)
+    transport = transport.to_s.camelize.to_sym
 
+    LogstashRails::Transport.const_get(transport).new(options)
   end
+
 end

data/lib/logstash_rails/configuration_base.rb

@@ -0,0 +1,45 @@
+module LogstashRails
+  class ConfigurationBase
+
+    def initialize(options)
+      @events = options[:events] || [/.*/]
+      @logger = options[:logger]
+
+      if defined?(Rails)
+        @logger ||= Rails.logger
+      end
+
+      subscribe
+    end
+
+    def destroy
+      return unless @subscriptions
+
+      @subscriptions.each do |subscription|
+        ActiveSupport::Notifications.unsubscribe(subscription)
+      end
+    end
+
+    private
+
+    def subscribe
+      @subscriptions = @events.map do |event|
+        ActiveSupport::Notifications.subscribe(event) do |*args|
+          json_event = Formatter.format(*args)
+
+          begin
+            push(json_event)
+          rescue
+            log($!)
+          end
+        end
+      end
+    end
+
+    def log(exception)
+      msg = exception.message + "\n " + exception.backtrace.join("\n ")
+      @logger.error(msg) if @logger
+    end
+
+  end
+end

data/lib/logstash_rails/transport.rb

@@ -0,0 +1,12 @@
+Dir[File.join(File.dirname(__FILE__), 'transport', '*.rb')].each do |file|
+  require file
+end
+
+module LogstashRails
+  module Transport
+    def self.get(transport)
+      constant_name = transport.to_s.camelize.to_sym
+      LogstashRails::Transport.const_get(constant_name)
+    end
+  end
+end

data/lib/logstash_rails/transport/logstash_tcp.rb

@@ -0,0 +1,25 @@
+module LogstashRails
+  module Transport
+    class LogstashTcp < ConfigurationBase
+
+      def initialize(options)
+        super
+
+        host = options[:host] || 'localhost'
+        port = options.fetch(:port)
+
+        @socket = TCPSocket.new(host, port)
+      end
+
+      def push(json_event)
+        @socket.write(json_event)
+      end
+
+      def destroy
+        super
+        @socket.close
+      end
+
+    end
+  end
+end

data/lib/logstash_rails/transport/logstash_udp.rb

@@ -0,0 +1,20 @@
+module LogstashRails
+  module Transport
+    class LogstashUdp < ConfigurationBase
+
+      def initialize(options = {})
+        super
+
+        host = options[:host] || 'localhost'
+        port = options[:port] || 9999
+
+        @socket = UDPSocket.new.tap{|s| s.connect(host, port) }
+      end
+
+      def push(json_event)
+        @socket.write(json_event)
+      end
+
+    end
+  end
+end

data/lib/logstash_rails/transport/redis.rb

@@ -0,0 +1,24 @@
+module LogstashRails
+  module Transport
+    class Redis < LogstashRails::ConfigurationBase
+
+      def initialize(options)
+        host = options[:host] || '127.0.0.1'
+        port = options[:port] || 6379
+        redis_key = options[:redis_key] || 'logstash'
+
+        @redis = ::Redis.new(host: host, port: port)
+        @redis_key = redis_key
+
+        super
+      end
+
+      def push(json_event)
+        unless @redis.rpush(@redis_key, json_event)
+          raise "could not send event to redis"
+        end
+      end
+
+    end
+  end
+end

data/lib/logstash_rails/version.rb

@@ -1,3 +1,3 @@
 module LogstashRails
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/logstash_rails.gemspec

@@ -7,14 +7,13 @@ Gem::Specification.new do |gem|
   gem.version       = LogstashRails::VERSION
   gem.authors       = ["cmertz"]
   gem.email         = ["chris@nimel.de"]
-  gem.description   = %q{Send Logstash events from a Rails application to Redis}
-  gem.summary       = %q{Send Logstash events from a Rails application to Redis}
-  gem.homepage      = ""
+  gem.summary       = %q{Send events from Rails to Logstash without logger foo.}
+  gem.description   = %q{Send events from Rails to Logstash without logger foo.}
+  gem.homepage      = "https://github.com/cmertz/logstash_rails"
   gem.license       = "GPL"
 
   gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.test_files    = gem.files.grep(%r{^spec/})
   gem.require_paths = ["lib"]
 
   gem.add_dependency('logstash-event')

data/spec/lib/logstash_rails/configuration_spec.rb

@@ -0,0 +1,33 @@
+describe LogstashRails::ConfigurationBase do
+
+  subject do
+    LogstashRails
+  end
+
+  it 'raises if no transport is specified' do
+    expect { subject.config({}) }.to raise_error(KeyError)
+  end
+
+  it 'handles all events by default' do
+    config = subject.config(transport: :redis)
+
+    config.should_receive(:push)
+
+    ActiveSupport::Notifications.instrument('foobar_event')
+
+    config.destroy
+  end
+
+  it 'logs exceptions if a logger is given' do
+    logger = mock(:logger)
+    config = subject.config(transport: :redis, logger: logger)
+    config.stub(:push).and_raise(ArgumentError.new)
+
+    logger.should_receive(:error)
+
+    ActiveSupport::Notifications.instrument('foobar_event')
+
+    config.destroy
+  end
+
+end

data/spec/{event_spec.rb → lib/logstash_rails/formatter_spec.rb}

@@ -1,23 +1,17 @@
-require 'spec_helper'
-
 describe 'generated logstash event' do
 
   before do
     Redis::Connection::Memory.reset_all_databases
-    LogstashRails.config(redis)
+    LogstashRails.config(transport: :redis, redis: Redis.new, redis_key: 'logstash')
     ActiveSupport::Notifications.instrument("process_action.action_controller")
   end
 
-  def redis
-    Redis.new
-  end
-
   it 'is parsebale json' do
-    JSON.parse(redis.lpop('logstash'))
+    JSON.parse(Redis.new.lpop('logstash'))
   end
 
   it 'has the event type as message' do
-    JSON.parse(redis.lpop('logstash'))['@message'].must_equal "process_action.action_controller"
+    JSON.parse(Redis.new.lpop('logstash'))['@message'].should eq "process_action.action_controller"
   end
 
 end

data/spec/lib/logstash_rails/transport/logstash_tcp_spec.rb

@@ -0,0 +1,31 @@
+describe LogstashRails::Transport::LogstashTcp do
+
+  before do
+    @server = TCPServer.new(9000)
+
+    @thread = Thread.new do
+      client = @server.accept
+      @received = client.gets
+      client.close
+    end
+  end
+
+  after do
+    @server.close
+  end
+
+  let :logstash_tcp do
+    LogstashRails::Transport::LogstashTcp.new(port: 9000)
+  end
+
+  it do
+    logstash_tcp.should respond_to :push
+  end
+
+  it 'sends data over tcp' do
+    logstash_tcp.push 'toto'
+    logstash_tcp.destroy
+    @thread.join
+    @received.should eq 'toto'
+  end
+end

data/spec/lib/logstash_rails/transport/logstash_udp_spec.rb

@@ -0,0 +1,7 @@
+describe LogstashRails::Transport::LogstashUdp do
+  subject do
+    LogstashRails::Transport::LogstashUdp.new
+  end
+
+  it { should respond_to :push }
+end

data/spec/lib/logstash_rails/transport/redis_spec.rb

@@ -0,0 +1,22 @@
+describe LogstashRails::Transport::Redis do
+
+  before do
+    Redis::Connection::Memory.reset_all_databases
+  end
+
+  subject do
+    LogstashRails::Transport::Redis.new(
+      redis:      Redis.new,
+      redis_key: 'logstash'
+    )
+  end
+
+  it { should respond_to :push }
+
+  it 'writes events to a redis list' do
+    subject.push('foobar_event')
+
+    Redis.new.lpop('logstash').should eq 'foobar_event'
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstash_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-05 00:00:00.000000000 Z
+date: 2013-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
@@ -59,7 +59,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Send Logstash events from a Rails application to Redis
+description: Send events from Rails to Logstash without logger foo.
 email:
 - chris@nimel.de
 executables: []
@@ -67,21 +67,28 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/logstash_rails.rb
+- lib/logstash_rails/configuration_base.rb
 - lib/logstash_rails/formatter.rb
+- lib/logstash_rails/transport.rb
+- lib/logstash_rails/transport/logstash_tcp.rb
+- lib/logstash_rails/transport/logstash_udp.rb
+- lib/logstash_rails/transport/redis.rb
 - lib/logstash_rails/version.rb
 - logstash_rails.gemspec
-- spec/config_spec.rb
-- spec/error_spec.rb
-- spec/event_spec.rb
+- spec/lib/logstash_rails/configuration_spec.rb
+- spec/lib/logstash_rails/formatter_spec.rb
+- spec/lib/logstash_rails/transport/logstash_tcp_spec.rb
+- spec/lib/logstash_rails/transport/logstash_udp_spec.rb
+- spec/lib/logstash_rails/transport/redis_spec.rb
 - spec/spec_helper.rb
-- spec/subscription_spec.rb
-homepage: ''
+homepage: https://github.com/cmertz/logstash_rails
 licenses:
 - GPL
 post_install_message: 
@@ -96,7 +103,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4390785812541147448
+      hash: 133620392481037059
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -105,17 +112,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4390785812541147448
+      hash: 133620392481037059
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: Send Logstash events from a Rails application to Redis
+summary: Send events from Rails to Logstash without logger foo.
 test_files:
-- spec/config_spec.rb
-- spec/error_spec.rb
-- spec/event_spec.rb
+- spec/lib/logstash_rails/configuration_spec.rb
+- spec/lib/logstash_rails/formatter_spec.rb
+- spec/lib/logstash_rails/transport/logstash_tcp_spec.rb
+- spec/lib/logstash_rails/transport/logstash_udp_spec.rb
+- spec/lib/logstash_rails/transport/redis_spec.rb
 - spec/spec_helper.rb
-- spec/subscription_spec.rb
 has_rdoc: 

data/spec/config_spec.rb

@@ -1,27 +0,0 @@
-require 'spec_helper'
-
-describe 'LogstashRails.config' do
-
-  def redis
-    Redis.new
-  end
-
-  it 'raises an ArgumentError if the handle_all flag is not a boolean' do
-    lambda do
-      LogstashRails.config(redis, 'fookey', 'somerandomstring')
-    end.must_raise(ArgumentError)
-  end
-
-  it 'raises an ArgumentError if the key is not a string' do
-    lambda do
-      LogstashRails.config(redis, 123, true)
-    end.must_raise(ArgumentError)
-  end
-
-  it 'raises an ArgumentError if redis is nil' do
-    lambda do
-      LogstashRails.config(nil, 'fookey', true)
-    end.must_raise(ArgumentError)
-  end
-
-end

data/spec/error_spec.rb

@@ -1,16 +0,0 @@
-require 'spec_helper'
-require 'mocha/setup'
-
-describe 'error behaviour' do
-
-  it 'logs exception traces to the Rails logger' do
-    logger = MiniTest::Mock.new
-    logger.expect(:error, nil, [String])
-    LogstashRails.stubs(:log).returns(logger)
-
-    LogstashRails.config(1)
-
-    ActiveSupport::Notifications.instrument("process_action.action_controller")
-  end
-
-end

data/spec/subscription_spec.rb

@@ -1,57 +0,0 @@
-require 'spec_helper'
-
-describe LogstashRails do
-
-  before do
-    Redis::Connection::Memory.reset_all_databases
-  end
-
-  def redis
-    Redis.new
-  end
-
-  it 'handles all events by default' do
-    LogstashRails.config(redis)
-
-    ActiveSupport::Notifications.instrument("process_action.action_controller")
-
-    redis.lpop('logstash').wont_be_nil
-  end
-
-  it 'does not handle events unless told to' do
-    LogstashRails.config(redis, 'logtstash', false)
-
-    ActiveSupport::Notifications.instrument("process_action.action_controller")
-
-    redis.lpop('logstash').must_be_nil
-  end
-
-  it 'handles events explicitly subscribed to' do
-    LogstashRails.config(redis, 'logstash', false)
-    LogstashRails.subscribe("process_action.action_controller")
-
-    ActiveSupport::Notifications.instrument("process_action.action_controller")
-
-    redis.lpop('logstash').wont_be_nil
-  end
-
-  it 'can be unsubscribed from events' do
-    LogstashRails.config(redis, 'logtstash', false)
-    LogstashRails.subscribe("process_action.action_controller")
-    LogstashRails.unsubscribe("process_action.action_controller")
-
-    ActiveSupport::Notifications.instrument("process_action.action_controller")
-
-    redis.lpop('logstash').must_be_nil
-  end
-
-  it 'uses the provided redis key' do
-    LogstashRails.config(redis, 'foorediskey', false)
-    LogstashRails.subscribe("process_action.action_controller")
-
-    ActiveSupport::Notifications.instrument("process_action.action_controller")
-
-    redis.lpop('foorediskey').wont_be_nil
-  end
-
-end