mlangenberg-merb_xmpp 0.0.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2008 Matthijs Langenberg
+
+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.textile

@@ -0,0 +1,37 @@
+h1. Merb_XMPP
+
+A plugin for the Merb framework that allows you to send XMPP/Jabber notifications from Merb applications.
+If you quickly want to notify a user (if his cheeseburger is ready), this is the plugin you need!
+It doesn't seperate composition and sending into micro MVC yet (like merb-mailer does), but that's on my TODO list (just like merging with merb-mailer).
+
+h2. Installation
+
+(sudo) gem install mlangenberg-merb_xmpp
+
+h2. Configuration
+
+Add a 'merb_xmpp' dependency in init.rb and add set the configuration like so.
+<pre><code class="ruby">
+Merb::Xmpp.config = {
+	:user => 'user@jabber.org',
+	:password => 'some-secrect-password',
+	:persistent => true, #this is optional if you don't want the jabber client to disconnect after delivery
+	:test_send => true #also optional, will add messages to Merb::Xmpp.deliveries array instead of sending.
+}
+</code></pre>
+
+h2. Usage
+
+Sending a jabber message to a user is really easy:
+
+<pre><code class="ruby">
+message = Merb::Xmpp.new(:to => 'another_user@jabber.org', :body => 'cheezburger ready!')
+message.deliver
+</code></pre>
+
+You can also specify multiple receipients.
+
+<pre><code class="ruby">
+message = Merb::Xmpp.new(:to => ['user_one@jabber.org', 'user_two@jabber.org'], :body => 'cheezburger ready!')
+message.deliver
+</code></pre>

data/lib/merb_xmpp.rb

@@ -0,0 +1 @@
+require 'merb_xmpp/xmpp'

data/lib/merb_xmpp/xmpp.rb

@@ -0,0 +1,53 @@
+begin
+  require 'xmpp4r-simple'
+rescue LoadError # TODO isn't this the job of the gem dependencies?
+  Merb.logger.warn "You need to install the xmpp4r-simple gem to use Merb::Xmpp"
+end
+
+module Merb
+  class Xmpp
+    class_inheritable_accessor :config, :deliveries
+    self.deliveries = []
+    
+    # ==== Parameters
+    # message<Hash>:: Outgoing message
+    def initialize(message={})
+      @message = message
+    end
+    
+    def deliver
+      config[:test_send] ? test_send : real_send
+    end
+    
+    def test_send
+      self.deliveries << @message
+    end
+    
+    def real_send
+      @message[:to] = @message[:to].is_a?(Array) ? @message[:to] : [@message[:to]]
+      connection do |im|
+        @message[:to].each do |jid|
+          im.deliver(jid, @message[:body])
+        end
+      end
+    end
+    
+    private
+    
+    def connection
+      im = if config[:persistent]
+        @@jabber ||= connect
+      else
+        connect
+      end
+      yield im
+      im.disconnect unless config[:persistent]
+    end
+    
+    
+    def connect
+      Jabber::Simple.new(config[:user], config[:password])
+    end
+
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: mlangenberg-merb_xmpp
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matthijs Langengerg
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: merb-core
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: xmpp4r-simple
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.7
+    version: 
+description: A plugin for the Merb framework that allows you to send XMPP/Jabber notifications from Merb applications.
+email: mlangenberg@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README.textile
+- lib/merb_xmpp.rb
+- lib/merb_xmpp/xmpp.rb
+has_rdoc: false
+homepage: 
+post_install_message: 
+rdoc_options: []
+
+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: 2
+summary: XMPP/Jabber notification plugin for Merb.
+test_files: []
+