hoptoad_zmq_notifier 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 hoptoad_notifier_zmq.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,34 @@
+= Hoptoad 0MQ Notifier
+
+Hoptoad notifier extension for speaking to the server over 0mq socket.
+  
+One should use this library to speak to Errbit server extended by Errbit 0MQ Handler (https://github.com/oruen/errbit_zmq_handler)
+
+== Installation
+
+Install zeromq 2.1 from http://www.zeromq.org/ or your favorite package system.
+
+Install the gem:
+
+  gem install hoptoad_zmq_notifier
+
+== Usage
+
+In the same initializer you initialize your Hoptoad Notifier client:
+  HoptoadNotifier.configure do |config|
+     config.api_key = 'ba134e3c7fab581e8685cde0a5e68728'
+     config.host    = 'localhost'
+     config.port    = 3000
+  end
+  
+  HoptoadZmqHandler.configure do |config|
+    # Address to connect to send exception notifications 
+    config.uri = "tcp://127.0.0.1:9998"
+  end
+
+From now all notices will be send through 0MQ socket to address you defined.
+
+== 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/hoptoad_notifier_zmq.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "hoptoad_zmq_notifier/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hoptoad_zmq_notifier"
+  s.version     = HoptoadZmqNotifier::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Nick Recobra"]
+  s.email       = ["oruenu@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{0MQ client for Errbit}
+  s.description = %q{Hoptoad Notifier extension making hoptoad client speak to server via 0MQ socket.}
+
+  s.rubyforge_project = "hoptoad_notifier_zmq"
+
+  s.add_dependency 'hoptoad_notifier', '> 0'
+  s.add_dependency 'ffi-rzmq'
+  s.add_dependency 'ffi'
+  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/hoptoad_zmq_notifier/configuration.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+module HoptoadZmqNotifier
+  # Used to set up and modify settings for the notifier.
+  class Configuration
+
+    OPTIONS = [:mailbox_size, :uri].freeze
+
+    # Size of outgoing messages queue. All messages over this value will be dropped.
+    attr_accessor :mailbox_size
+
+    # The uri to connect to (0MQ socket)
+    attr_accessor :uri
+
+    def initialize
+      @mailbox_size = 200
+    end
+
+    def zmq_context
+      @zmq_context ||= ZMQ::Context.new
+    end
+
+    def socket
+      @socket ||= begin
+        s = zmq_context.socket ZMQ::PUB
+        s.connect @uri
+        s.setsockopt(ZMQ::HWM, mailbox_size)
+        s
+      end
+    end
+
+    # 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/hoptoad_zmq_notifier/sender.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+require 'ffi'
+require 'ffi-rzmq'
+
+module HoptoadZmqNotifier
+  class Sender
+    def send_to_hoptoad data
+      logger.debug { "Sending request to #{@uri}:\n#{data}" } if logger
+      socket.send_string data
+    end
+
+    def initialize(options = {})
+      [:mailbox_size, :uri].each do |option|
+        instance_variable_set("@#{option}", options[option])
+      end
+    end
+
+    private
+    def logger
+      HoptoadNotifier.logger
+    end
+
+    def socket
+      @socket ||= HoptoadZmqNotifier.configuration.socket
+    end
+  end
+end

data/lib/hoptoad_zmq_notifier/version.rb

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

data/lib/hoptoad_zmq_notifier.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+require 'hoptoad_notifier'
+module HoptoadZmqNotifier
+  autoload :Configuration, 'hoptoad_zmq_notifier/configuration'
+  autoload :Sender, 'hoptoad_zmq_notifier/sender'
+  class << self
+    # The sender object is responsible for delivering formatted data to the Hoptoad server.
+    # Must respond to #send_to_hoptoad. See HoptoadNotifier::Sender.
+    attr_accessor :sender
+
+    # A Hoptoad Notifier ZMQ configuration object. Must act like a hash and return sensible
+    # values for all Hoptoad ZMQ configuration options. See HoptoadNotifierZmq::Configuration.
+    attr_accessor :configuration
+
+    # Call this method to modify defaults in your initializers.
+    #
+    # @example
+    #   HoptoadNotifierZmq.configure do |config|
+    #     config.mailbox_sizr = 1000
+    #     config.uri  = 'tcp://errbit.home:9999'
+    #   end
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+      self.sender = Sender.new(configuration)
+    end
+  end
+end
+
+HoptoadNotifier.configure do |config|
+end
+
+module HoptoadNotifier
+  class Sender
+    def send_to_hoptoad *args
+      HoptoadZmqNotifier.sender.send_to_hoptoad(*args)
+    end
+  end
+end

data/spec/lib/hoptoad_notifier_zmq/configuration_spec.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe HoptoadZmqNotifier::Configuration do
+  it "should provide default mailbox size" do
+    assert_config_default :mailbox_size, 200
+  end
+
+  it "should mailbox size to be overitten" do
+    assert_config_overridable :mailbox_size
+  end
+
+  it "should have an uri" do
+    assert_config_overridable :uri
+  end
+end
+
+def assert_config_overridable(option, value = 'a value')
+  config = HoptoadZmqNotifier::Configuration.new
+  config.send(:"#{option}=", value)
+  config.send(option).should == value
+end
+
+def assert_config_default(option, default_value, config = nil)
+  config ||= HoptoadZmqNotifier::Configuration.new
+  config.send(option).should == default_value
+end

data/spec/lib/hoptoad_notifier_zmq/sender_spec.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe HoptoadZmqNotifier::Sender do
+  before(:each) do
+    @uri = "tcp://127.0.0.1:9998"
+    @message = "sample message"
+    @mailbox_size = 35
+    HoptoadZmqNotifier.configure do |config|
+      config.uri = @uri
+      config.mailbox_size = @mailbox_size
+    end
+
+    ctx = ZMQ::Context.new
+    @subscriber = ctx.socket ZMQ::SUB
+    @subscriber.bind(@uri)
+    @subscriber.setsockopt ZMQ::SUBSCRIBE, ""
+  end
+
+  after :each do
+    @subscriber.close
+  end
+
+  it "should send messages via 0MQ" do
+    HoptoadNotifier.sender.send_to_hoptoad(@message)
+    sleep 1
+    @subscriber.recv_string(ZMQ::NOBLOCK).should == @message
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: hoptoad_zmq_notifier
+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: hoptoad_notifier
+  requirement: &2153369360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153369360
+- !ruby/object:Gem::Dependency
+  name: ffi-rzmq
+  requirement: &2153368940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153368940
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: &2153368480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153368480
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2153367980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *2153367980
+description: Hoptoad Notifier extension making hoptoad client speak to server via
+  0MQ socket.
+email:
+- oruenu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- hoptoad_notifier_zmq.gemspec
+- lib/hoptoad_zmq_notifier.rb
+- lib/hoptoad_zmq_notifier/configuration.rb
+- lib/hoptoad_zmq_notifier/sender.rb
+- lib/hoptoad_zmq_notifier/version.rb
+- spec/lib/hoptoad_notifier_zmq/configuration_spec.rb
+- spec/lib/hoptoad_notifier_zmq/sender_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: hoptoad_notifier_zmq
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: 0MQ client for Errbit
+test_files:
+- spec/lib/hoptoad_notifier_zmq/configuration_spec.rb
+- spec/lib/hoptoad_notifier_zmq/sender_spec.rb
+- spec/spec_helper.rb