errbit_zmq_handler 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in errbit_zmq_handler.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2011, Nick Recobra
+
+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.rdoc

@@ -0,0 +1,42 @@
+= Errbit 0MQ Handler
+
+Errbit notifier extension for handling notices over 0mq socket.
+  
+One should use this library to listen to Hoptoad 0MQ Notifier powered app (https://github.com/oruen/hoptoad_zmq_notifier)
+
+Advantage of using Errbit 0MQ Handler is async notices processing. You could fire notices from the client and not depend on
+timeouts, service unavailability and services errors.
+
+== Installation
+
+Install zeromq 2.1 from http://www.zeromq.org or your favorite package system.
+
+Get Errbit https://github.com/oruen/errbit (my fork is more stable and featured :)
+
+Install the gem:
+
+  gem install errbit_zmq_handler
+
+== Usage
+
+Config 0MQ handler by defining it's address it <tt>config/initializers/errbit_zmq_handler.rb</tt>:
+  
+  ErrbitZmqHandler.configure do |config|
+    # Address to bind to listen exception notifications 
+    config.uri = "tcp://127.0.0.1:9998"
+  end
+
+Starting handler daemon:
+  APP_ROOT=/path/to/app/root RAILS_ENV=production errbit_zmq_handler start
+
+Stop handler daemon:
+  APP_ROOT=/path/to/app/root RAILS_ENV=production errbit_zmq_handler stop
+
+Restart handler daemon:
+  APP_ROOT=/path/to/app/root RAILS_ENV=production errbit_zmq_handler restart
+
+
+== License
+
+HoptoadZmqNotifier is Copyright © 2011 oruen. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
+

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+end
+task :default => :spec
+

data/bin/errbit_zmq_handler

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+app_root = ENV["APP_ROOT"] || "."
+
+require 'daemon_spawn'
+
+module ErrbitZmqHandler
+  class Daemon < DaemonSpawn::Base
+    def start(args)
+      puts "[#{Time.now}] Starting"
+      require File.expand_path('config/environment', working_dir)
+      Rails.logger = ActiveSupport::BufferedLogger.new log_file
+      Mongoid.logger = Rails.logger
+      ErrbitZmqHandler.handler.start!
+    end
+  
+    def stop
+      puts "[#{Time.now}] Shutting down"
+    end
+  end
+end
+
+ErrbitZmqHandler::Daemon.spawn!(:log_file => "#{app_root}/log/errbit_zmq_handler.log",
+                                :pid_file => "#{app_root}/tmp/pids/errbit_zmq_handler.pid",
+                                :sync_log => true,
+                                :singleton => true,
+                                :working_dir => app_root)

data/errbit_zmq_handler.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "errbit_zmq_handler/version"
+
+Gem::Specification.new do |s|
+  s.name        = "errbit_zmq_handler"
+  s.version     = ErrbitZmqHandler::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Nick Recobra"]
+  s.email       = ["oruenu@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Errbit handler for 0MQ notices}
+  s.description = %q{Errbit extension providing handler for notices transfered via 0MQ}
+
+  s.rubyforge_project = "errbit_zmq_handler"
+
+  s.add_dependency "ffi", ">= 0"
+  s.add_dependency "yajl-ruby", "> 0"
+  s.add_dependency "dripdrop", ">= 0.10.0.beta2"
+  s.add_dependency "daemon-spawn", ">= 0.4.0"
+
+  s.add_development_dependency 'rspec', '>= 2.5.0'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/errbit_zmq_handler/configuration.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+module ErrbitZmqHandler
+  # Used to set up and modify settings for the notifier.
+  class Configuration
+
+    OPTIONS = [:uri].freeze
+
+    # The uri to bind to (0MQ socket)
+    attr_accessor :uri
+
+    # Allows config options to be read like a hash
+    #
+    # @param [Symbol] option Key for a given attribute
+    def [](option)
+      send(option)
+    end
+
+    # Returns a hash of all configurable options
+    def to_hash
+      OPTIONS.inject({}) do |hash, option|
+        hash.merge(option.to_sym => send(option))
+      end
+    end
+
+    # Returns a hash of all configurable options merged with +hash+
+    #
+    # @param [Hash] hash A set of configuration options that will take precedence over the defaults
+    def merge(hash)
+      to_hash.merge(hash)
+    end
+  end
+end

data/lib/errbit_zmq_handler/handler.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+require 'dripdrop'
+module ErrbitZmqHandler
+  class Handler < DripDrop::Node
+    attr_accessor :uri
+    def action
+      self.uri = ErrbitZmqHandler.configuration.uri 
+      route :exceptions, :zmq_subscribe, uri, :bind, :msg_format => :raw
+
+      exceptions.on_recv do |messages|
+        xml = messages.first.copy_out_string
+        puts "[#{Time.now}] got notice"
+        start = Time.now
+        Notice.from_xml(xml)
+        puts "Notice saved in #{Time.now - start} seconds\n\n"
+      end
+    end
+  end
+end

data/lib/errbit_zmq_handler/version.rb

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

data/lib/errbit_zmq_handler.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+Thread.abort_on_exception = true
+
+module ErrbitZmqHandler
+  autoload :Configuration, 'errbit_zmq_handler/configuration'
+  autoload :Handler, 'errbit_zmq_handler/handler'
+  autoload :VERSION, 'errbit_zmq_handler/version'
+  class << self
+    # A Errbit ZMQ Handler configuration object. Must act like a hash and return sensible
+    # values for all Hoptoad ZMQ configuration options. See ErrbitZmqHandler::Configuration.
+    attr_accessor :configuration
+
+    # Call this method to modify defaults in your initializers.
+    #
+    # @example
+    #   ErrbitZmqHandler.configure do |config|
+    #     config.mailbox_size = 1000
+    #     config.uri  = 'tcp://errbit.home:9999'
+    #   end
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+
+    # The handler object is responsible for delivering formatted data to the Hoptoad server.
+    # Must respond to #start!. See ErrbitZmqHandler::Handler.
+    def handler
+      @handler ||= Handler.new.tap {|h| h.uri = ErrbitZmqHandler.configuration.uri}
+    end
+  end
+end
+

data/spec/fixtures/notice.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<notice version="2.0">
+  <api-key>76fdb93ab2cf276ec080671a8b3d3866</api-key>
+  <notifier>
+    <name>Hoptoad Notifier</name>
+    <version>1.2.4</version>
+    <url>http://hoptoadapp.com</url>
+  </notifier>
+  <error>
+    <class>RuntimeError</class>
+    <message>RuntimeError: I've made a huge mistake</message>
+    <backtrace>
+      <line method="public" file="/testapp/app/models/user.rb" number="53"/>
+      <line method="index" file="/testapp/app/controllers/users_controller.rb" number="14"/>
+    </backtrace>
+  </error>
+  <request>
+    <url>http://example.com</url>
+    <component/>
+    <action/>
+    <cgi-data>
+      <var key="SERVER_NAME">example.org</var>
+      <var key="HTTP_USER_AGENT">Mozilla</var>
+    </cgi-data>
+  </request>
+  <server-environment>
+    <project-root>/testapp</project-root>
+    <environment-name>production</environment-name>
+  </server-environment>
+</notice>

data/spec/lib/errbit_zmq_handler/configuration_spec.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe ErrbitZmqHandler::Configuration do
+  it "should have an uri" do
+    assert_config_overridable :uri
+  end
+
+  it "should set handler uri" do
+    @uri = "tcp://localhost"
+    ErrbitZmqHandler.configure do |config|
+      config.uri = @uri
+    end
+
+    ErrbitZmqHandler.handler.uri.should == @uri 
+  end
+end
+
+def assert_config_overridable(option, value = 'a value')
+  config = ErrbitZmqHandler::Configuration.new
+  config.send(:"#{option}=", value)
+  config.send(option).should == value
+end
+
+def assert_config_default(option, default_value, config = nil)
+  config ||= ErrbitZmqHandler::Configuration.new
+  config.send(option).should == default_value
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+require 'rubygems'
+require 'rspec'
+require 'errbit_zmq_handler'
+
+RSpec.configure do |c|
+  c.mock_with :rspec
+end
+

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: errbit_zmq_handler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Nick Recobra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-03-03 00:00:00.000000000 +03:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: &2164843040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164843040
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &2164842500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164842500
+- !ruby/object:Gem::Dependency
+  name: dripdrop
+  requirement: &2164842040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.0.beta2
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164842040
+- !ruby/object:Gem::Dependency
+  name: daemon-spawn
+  requirement: &2164841580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164841580
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2164841120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *2164841120
+description: Errbit extension providing handler for notices transfered via 0MQ
+email:
+- oruenu@gmail.com
+executables:
+- errbit_zmq_handler
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- bin/errbit_zmq_handler
+- errbit_zmq_handler.gemspec
+- lib/errbit_zmq_handler.rb
+- lib/errbit_zmq_handler/configuration.rb
+- lib/errbit_zmq_handler/handler.rb
+- lib/errbit_zmq_handler/version.rb
+- spec/fixtures/notice.xml
+- spec/lib/errbit_zmq_handler/configuration_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: errbit_zmq_handler
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Errbit handler for 0MQ notices
+test_files:
+- spec/fixtures/notice.xml
+- spec/lib/errbit_zmq_handler/configuration_spec.rb
+- spec/spec_helper.rb