badcarl-integrity-jabber 0.0.2

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Carl Porth
+
+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,7 @@
+= integrity-jabber
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 Carl Porth. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "integrity-jabber"
+    gem.summary = %Q{A jabber notifier for integrity}
+    gem.email = "badcarl@gmail.com"
+    gem.homepage = "http://github.com/badcarl/integrity-jabber"
+    gem.authors = ["Carl Porth"]
+    gem.add_dependency 'integrity'
+    gem.add_dependency 'xmpp4r'
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new('test:unit') do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/unit/**/*_test.rb'
+  test.verbose = true
+end
+
+Rake::TestTask.new('test:remote') do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/remote/**/*_test.rb'
+  test.verbose = true
+end
+
+task :test => 'test:unit'
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/integrity-jabber.gemspec

@@ -0,0 +1,55 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{integrity-jabber}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Carl Porth"]
+  s.date = %q{2009-07-03}
+  s.email = %q{badcarl@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "integrity-jabber.gemspec",
+     "lib/integrity/notifier/config.haml",
+     "lib/integrity/notifier/jabber.rb",
+     "test/remote/integrity-jabber-test-config.yml.sample",
+     "test/remote/integrity_jabber_remote_test.rb",
+     "test/test_helper.rb",
+     "test/unit/integrity_jabber_test.rb"
+  ]
+  s.homepage = %q{http://github.com/badcarl/integrity-jabber}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{A jabber notifier for integrity}
+  s.test_files = [
+    "test/remote/integrity_jabber_remote_test.rb",
+     "test/test_helper.rb",
+     "test/unit/integrity_jabber_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<integrity>, [">= 0"])
+      s.add_runtime_dependency(%q<xmpp4r>, [">= 0"])
+    else
+      s.add_dependency(%q<integrity>, [">= 0"])
+      s.add_dependency(%q<xmpp4r>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<integrity>, [">= 0"])
+    s.add_dependency(%q<xmpp4r>, [">= 0"])
+  end
+end

data/lib/integrity/notifier/config.haml

@@ -0,0 +1,21 @@
+%h3 Jabber Server Configuration
+
+%p.normal
+  %label{ :for => "jabber_notifier_jid" } Jabber ID
+  %input.text#jabber_notifier_jid{ :name => "notifiers[Jabber][jid]", :value => config["jid"], :type => "text" }
+
+%p.normal
+  %label{ :for => "jabber_notifier_password" } Password
+  %input.text#jabber_notifier_password{ :name => "notifiers[Jabber][password]", :value => config["password"], :type => "text" }
+
+%p.normal
+  %label{ :for => "jabber_notifier_to" } To
+  %input.text#jabber_notifier_to{ :name => "notifiers[Jabber][to]", :value => config["to"], :type => "text" }
+
+%p.normal
+  %label{ :for => "jabber_notifier_server" } Server
+  %input.text#jabber_notifier_server{ :name => "notifiers[Jabber][server]", :value => config["server"], :type => "text" }
+
+%p.normal
+  %label{ :for => "jabber_notifier_port" } Port
+  %input.text#jabber_notifier_port{ :name => "notifiers[Jabber][port]", :value => config["port"], :type => "text" }

data/lib/integrity/notifier/jabber.rb

@@ -0,0 +1,42 @@
+require "integrity"
+require "xmpp4r"
+
+module Integrity
+  class Notifier
+    class Jabber < Notifier::Base
+
+      def self.to_haml
+        File.read(File.dirname(__FILE__) + "/config.haml")
+      end
+
+      def initialize(commit, config={})
+        super(commit, config)
+
+        @client   = ::Jabber::Client.new(config.delete('jid'))
+        @password = config.delete('password')
+        @port     = config.delete('port')
+        @server   = config.delete('server')
+        @to       = config.delete('to').split(/\s+/)
+
+        @server = nil  if @server.blank?
+        @port   = 5222 if @port.blank?
+      end
+
+      def deliver!
+        @client.connect(@server, @port.to_i)
+        @client.auth(@password)
+
+        @to.each do |to|
+          message = ::Jabber::Message.new(to, full_message)
+          message.type = :chat
+          @client.send(message)
+        end
+
+        @client.close
+      end
+
+    end
+
+    register Jabber
+  end
+end

data/test/remote/integrity-jabber-test-config.yml.sample

@@ -0,0 +1,10 @@
+receiver:
+  jid: client1@localhost/receiver
+  password: client1
+  server: localhost
+  port: 5222
+notifier:
+  jid: client2@localhost/notifier
+  password: client2
+  server: localhost
+  port: 5222

data/test/remote/integrity_jabber_remote_test.rb

@@ -0,0 +1,98 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class IntegrityJabberRemoteTest < Test::Unit::TestCase
+  include Integrity::Notifier::Test
+
+  CONFIG_FILE = ENV['JABBER_CONFIG'] || '~/.integrity-jabber-test-config.yml'
+
+  def notifier
+    "Jabber"
+  end
+
+  def setup
+    begin
+      @test_config = File.open(File.expand_path(CONFIG_FILE)) do |io|
+        YAML::load(io)
+      end
+      raise unless @test_config
+    rescue => e
+      puts "Place a yaml file at #{CONFIG_FILE} with jabber test config, for example:"
+      puts File.read(File.dirname(__FILE__) + '/integrity-jabber-test-config.yml.sample')
+      raise e
+    end
+
+    %w[ notifier receiver ].each do |client|
+      @test_config[client] or raise "Need to configure #{client}: in #{CONFIG_FILE}"
+      %w[ jid password server port ].each do |key|
+        @test_config[client][key] or raise "Need to configure #{client}: #{key}: in #{CONFIG_FILE}"
+      end
+    end
+
+    setup_database
+
+    @notifier_config = {
+      'jid'      => @test_config['notifier']['jid'],
+      'password' => @test_config['notifier']['password'],
+      'server'   => @test_config['notifier']['server'],
+      'port'     => @test_config['notifier']['port'],
+
+      'to'       => @test_config['receiver']['jid']
+    }
+  end
+
+  def test_it_sends_successful_jabber_notification
+    successful = Integrity::Commit.gen(:successful)
+
+    message = deliver(successful)
+
+    assert_not_nil message
+
+    assert_equal @test_config['receiver']['jid'], message.to.to_s
+    assert_equal @test_config['notifier']['jid'], message.from.to_s
+
+    assert message.body.include?("successful")
+    assert message.body.include?(successful.committed_at.to_s)
+    assert message.body.include?(successful.author.name)
+    assert message.body.include?(successful.output)
+  end
+
+  def test_it_sends_failed_jabber_notification
+    failed = Integrity::Commit.gen(:failed)
+
+    message = deliver(failed)
+
+    assert_not_nil message
+
+    assert_equal @test_config['receiver']['jid'], message.to.to_s
+    assert_equal @test_config['notifier']['jid'], message.from.to_s
+
+    assert message.body.include?("failed")
+    assert message.body.include?(failed.committed_at.to_s)
+    assert message.body.include?(failed.author.name)
+    assert message.body.include?(failed.output)
+  end
+
+private
+
+  def deliver(commit)
+    receiver = ::Jabber::Client.new(@test_config['receiver']['jid'])
+    receiver.add_message_callback do |message|
+      Thread.main[:message] = message
+      Thread.main.wakeup
+    end
+
+    Timeout::timeout(15) do
+      receiver.connect(@test_config['receiver']['server'], @test_config['receiver']['port'])
+      receiver.auth(@test_config['receiver']['password'])
+      receiver.send(::Jabber::Presence.new(nil, nil, 127))
+
+      Integrity::Notifier::Jabber.new(commit, @notifier_config.dup).deliver!
+      Thread.stop # wait to be woken up by callback
+    end
+
+    Thread.current[:message]
+  ensure
+    receiver.close
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+$:.unshift File.dirname(__FILE__) + "/../lib", File.dirname(__FILE__)
+
+require "rubygems"
+
+if dm_version = ENV['DM_VERSION']
+  gem 'dm-core',        dm_version
+  gem 'dm-sweatshop',   dm_version
+  gem 'dm-validations', dm_version
+  gem 'dm-types',       dm_version
+  gem 'dm-timestamps',  dm_version
+  gem 'dm-aggregates',  dm_version
+end
+
+require "integrity"
+require "integrity/notifier/test"
+require "integrity/notifier/jabber"
+
+require "test/unit"
+require "xmpp4r"
+require "mocha"

data/test/unit/integrity_jabber_test.rb

@@ -0,0 +1,79 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class IntegrityJabberTest < Test::Unit::TestCase
+  include Integrity::Notifier::Test
+
+  def notifier
+    "Jabber"
+  end
+
+  def setup
+    setup_database
+
+    @config = {
+      'jid' => 'notifier@localhost',
+      'password' => 'secret',
+      'to' => 'receiver@localhost'
+    }
+
+    @commit = Integrity::Commit.gen(:successful)
+
+    @client = stub_everything('jabber_client', :send => nil)
+    ::Jabber::Client.stubs(:new).returns(@client)
+  end
+
+  def test_configuration_form
+    assert form_have_tag?("h3", :content => "Jabber Server Configuration")
+
+    assert provides_option?("jid",      "foo@example.org")
+    assert provides_option?("password", "secret")
+    assert provides_option?("server",   "example.org")
+    assert provides_option?("port",     "5222")
+    assert provides_option?("to",       "bar@example.org")
+  end
+
+  def test_configuration_with_server
+    @client.expects(:connect).with('example.com', anything)
+
+    Integrity::Notifier::Jabber.new(@commit, @config.merge('server' => 'example.com')).deliver!
+  end
+
+  def test_configuration_without_server
+    @client.expects(:connect).with(nil, anything)
+
+    Integrity::Notifier::Jabber.new(@commit, @config.merge('server' => '')).deliver!
+  end
+
+  def test_configuration_with_port
+    @client.expects(:connect).with(anything, 5223)
+
+    Integrity::Notifier::Jabber.new(@commit, @config.merge('port' => '5223')).deliver!
+  end
+
+  def test_configuration_without_port
+    @client.expects(:connect).with(anything, 5222)
+
+    Integrity::Notifier::Jabber.new(@commit, @config.merge('port' => '')).deliver!
+  end
+
+  def test_sends_messages
+    @client.expects(:send).with { |message| message.to.to_s == 'client@localhost' }
+
+    Integrity::Notifier::Jabber.new(@commit, @config.merge('to' => 'client@localhost')).deliver!
+  end
+
+  def test_sends_multiple_messages
+    @client.expects(:send).with { |message| message.to.to_s == 'client1@localhost' }
+    @client.expects(:send).with { |message| message.to.to_s == 'client2@localhost/test' }
+    @client.expects(:send).with { |message| message.to.to_s == 'client3@localhost/resource' }
+
+    Integrity::Notifier::Jabber.new(@commit, @config.merge('to' => 'client1@localhost client2@localhost/test client3@localhost/resource')).deliver!
+  end
+
+  def test_closes_connection
+    @client.expects(:close)
+
+    Integrity::Notifier::Jabber.new(@commit, @config).deliver!
+  end
+
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: badcarl-integrity-jabber
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Carl Porth
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-03 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: integrity
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: xmpp4r
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: badcarl@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- integrity-jabber.gemspec
+- lib/integrity/notifier/config.haml
+- lib/integrity/notifier/jabber.rb
+- test/remote/integrity-jabber-test-config.yml.sample
+- test/remote/integrity_jabber_remote_test.rb
+- test/test_helper.rb
+- test/unit/integrity_jabber_test.rb
+has_rdoc: false
+homepage: http://github.com/badcarl/integrity-jabber
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: A jabber notifier for integrity
+test_files: 
+- test/remote/integrity_jabber_remote_test.rb
+- test/test_helper.rb
+- test/unit/integrity_jabber_test.rb