mack-notifier 0.8.0.101 → 0.8.1

data/lib/mack-notifier.rb

@@ -1,6 +1,9 @@
 require 'rubygems'
 require 'validatable'
 require 'tmail'
+# require 'xmpp4r/client'
+# require 'xmpp4r/roster'
+require 'xmpp4r-simple'
 
 fl = File.join(File.dirname(__FILE__), "mack-notifier")
 
@@ -22,4 +25,4 @@ require File.join(fl, "validations")
 
 require File.join(fl, "testing")
 
-require File.join(fl, "loader")
+require File.join(fl, "loader")

data/lib/mack-notifier/adapters/xmpp_msg.rb

@@ -0,0 +1,61 @@
+module Mack
+  module Notifier
+    module Adapters # :nodoc:
+      
+      class XmppMsgContainer 
+        attr_accessor :messages
+        attr_accessor :recipients
+        def initialize
+          self.messages = []
+          self.recipients = []
+        end
+        
+        def find_message_by_recipient(rcpt)
+          self.messages.find { |x| x.to.to_s == rcpt.to_s }
+        end
+        
+      end
+      
+      # All mail adapters need to extend this class.
+      class Xmpp < Mack::Notifier::Adapters::Base
+        include Jabber
+        
+        # The transformed (ie, converted, object)
+        def transformed
+          raise Mack::Errors::UnconvertedNotifier.new if @xmpp_msg.nil?
+          return @xmpp_container
+        end
+        
+        # Convert the Mack::Notifier object to the adapted object.
+        def convert
+          settings = configatron.mack.notifier.xmpp_settings
+          arr = [mack_notifier.to].flatten
+          @xmpp_container = XmppMsgContainer.new
+          @xmpp_container.recipients = arr
+          
+          arr.each do |rcpt|
+            xmpp_msg = Message::new
+            xmpp_msg.set_type(:normal)
+            xmpp_msg.set_to(rcpt)
+            xmpp_msg.set_from(mack_notifier.from)
+            xmpp_msg.set_subject(mack_notifier.subject)
+            xmpp_msg.set_type(settings.message_type)
+            unless mack_notifier.body(:plain).blank?
+              xmpp_msg.set_body(mack_notifier.body(:plain))
+            end
+
+            @xmpp_container.messages << xmpp_msg
+          end
+          
+          return @xmpp_container
+        end
+        
+        # The RAW encoded String ready for delivery via SMTP, Sendmail, etc...
+        def deliverable
+          return @xmpp_container
+        end
+        
+      end # Base
+    end # Adapters
+  end # Notifier
+end # Mack

data/lib/mack-notifier/delivery_handlers/sendmail.rb

@@ -5,7 +5,7 @@ module Mack
       module Sendmail
         
         def self.deliver(mail)
-          sendmail_settings = configatron.mack.notifier.sendmail_settings
+          sendmail_settings = configatron.mack.notifier.sendmail
           sendmail_args = sendmail_settings.arguments
           sendmail_args += " -f \"#{mail.reply_to}\"" if mail.reply_to
           IO.popen("#{sendmail_settings.location} #{sendmail_args}","w+") do |sm|

data/lib/mack-notifier/delivery_handlers/smtp.rb

@@ -6,7 +6,7 @@ module Mack
       module Smtp
         
         def self.deliver(mail)
-          smtp_settings = configatron.mack.notifier.smtp_settings
+          smtp_settings = configatron.mack.notifier.smtp
           Net::SMTP.start(smtp_settings.address, smtp_settings.port, 
                           smtp_settings.domain, smtp_settings.retrieve(:user_name, nil), 
                           smtp_settings.retrieve(:password, nil), smtp_settings.retrieve(:authentication, nil)) do |smtp|

data/lib/mack-notifier/delivery_handlers/xmpp_transport.rb

@@ -0,0 +1,78 @@
+module Mack
+  module Notifier
+    module DeliveryHandlers # :nodoc:
+      # Delivers Mack::Notifier objects using XMPP (Jabber)
+      module XmppTransport
+        
+        def self.check_availability(client, recipients)
+          buddies = {}
+          recipients.each do |rcpt|
+            buddies[rcpt] = :offline
+          end
+
+          # try to get the presence update
+          sleep(1)
+          client.presence_updates do |update|
+            from = update[0].to_s
+            presence = update[1].to_s
+            if buddies.has_key?(from)
+              buddies[from] = presence
+            end
+            Mack.logger.info "#{from} --> #{presence}"
+          end
+          return buddies
+        end
+        
+        def self.deliver_message(client, xmpp_msg, wait_for_response, xmpp_errors)
+          Mack.logger.info "#{xmpp_msg.to} is online, delivering message"
+          client.deliver(xmpp_msg.to, xmpp_msg)
+          loop do
+            client.received_messages { |ret_msg| @msg_received = true if ret_msg.body == "ack" }
+            break if @msg_received or @error
+          end if wait_for_response
+          return xmpp_errors
+        end
+        
+        def self.deliver(xmpp_msg)
+          @ex ||= Mack::Errors::XmppError.new("xmpp error")
+          xmpp_settings = configatron.mack.notifier.xmpp
+          jid_str = xmpp_settings.jid
+          jid_str += ("/" + xmpp_settings.jid_resource) if !jid_str.index("/")
+          password = xmpp_settings.password
+          client = Jabber::Simple.new(jid_str, password)
+          thr = Thread.new {
+            begin
+              xmpp_msg = xmpp_msg.deliverable
+              Timeout::timeout(20) do
+                buddies = check_availability(client, xmpp_msg.recipients)
+
+                online_buddies = buddies.keys.reject { |x| buddies[x].to_sym == :offline }
+                offline_buddies = buddies.keys.reject { |x| buddies[x].to_sym == :online }
+
+                if !offline_buddies.empty?
+                  # there are offline buddies, log the errors
+                  offline_buddies.each do |buddy|
+                    err = Mack::Errors::XmppUserNotOnline.new(buddy)
+                    @ex.add_error(:offline, err)
+                  end
+                end
+                
+                online_buddies.each do |buddy|
+                  deliver_message(client, xmpp_msg.find_message_by_recipient(buddy), xmpp_settings.wait_for_response, @ex)
+                end
+                
+                raise @ex if !@ex.empty?
+              end # timeout
+            rescue Timeout::Error => ex
+              @error = ex
+            rescue Exception => ex
+            end
+          }
+          
+          thr.join
+          raise @ex if !@ex.empty?
+        end
+      end # XmppTransport
+    end # DeliveryHandlers
+  end # Notifier
+end # Mack

data/lib/mack-notifier/errors.rb

@@ -7,5 +7,49 @@ module Mack
       end
     end # UnconvertedNotifier
     
+    class XmppError < StandardError
+      def initialize(msg)
+        super(msg)
+        self.error_hash = {}
+      end
+      
+      def add_error(type, msg)
+        self.error_hash[type] ||= []
+        self.error_hash[type] << msg
+      end
+      
+      def get_error(type)
+        self.error_hash[type]
+      end
+      
+      def empty?
+        self.error_hash.empty?
+      end
+      
+      attr_accessor :error_hash
+    end
+    
+    class XmppAuthenticationError < StandardError
+      def initialize(user)
+        super("Cannot authenticate: #{user} to xmpp server")
+      end
+    end
+    
+    class XmppUserNotOnline < StandardError
+      def initialize(user)
+        super("user #{user} is not online")
+      end
+    end
+    
+    class XmppSendError < StandardError
+      attr_reader :code
+      attr_reader :msg
+      
+      def initialize(code, msg)
+        super("Cannot send message. Code=#{code}, Msg=#{msg}")
+        @code = code
+        @msg = msg
+      end
+    end
   end # Errors
 end # Mack

data/lib/mack-notifier/loader.rb

@@ -2,6 +2,8 @@
 FileUtils.mkdir_p(Mack::Paths.notifiers)
 
 # Require all notifiers
-Dir.glob(Mack::Paths.notifiers("**/*.rb")).each do |notifier|
-  require notifier
+Mack.search_path(:app).each do |path|
+  Dir.glob(File.join(path, 'notifiers', "**/*.rb")).each do |notifier|
+    require File.expand_path(notifier)
+  end
 end

data/lib/mack-notifier/settings.rb

@@ -1,7 +1,16 @@
-configatron.mack.notifier.sendmail_settings.set_default(:location, '/usr/sbin/sendmail')
-configatron.mack.notifier.sendmail_settings.set_default(:arguments, '-i -t')
-configatron.mack.notifier.smtp_settings.set_default(:address, 'localhost')
-configatron.mack.notifier.smtp_settings.set_default(:port, 25)
-configatron.mack.notifier.smtp_settings.set_default(:domain, 'localhost.localdomain')
+configatron.mack.notifier.sendmail.set_default(:location, '/usr/sbin/sendmail')
+configatron.mack.notifier.sendmail.set_default(:arguments, '-i -t')
+configatron.mack.notifier.smtp.set_default(:address, 'localhost')
+configatron.mack.notifier.smtp.set_default(:port, 25)
+configatron.mack.notifier.smtp.set_default(:domain, 'localhost.localdomain')
 configatron.mack.notifier.set_default(:deliver_with, (Mack.env == "test" ? "test" : "smtp"))
 configatron.mack.notifier.set_default(:adapter, 'tmail')
+
+# xmpp settings
+configatron.mack.notifier.xmpp.set_default(:jid, 'h_test@jabber80.com')
+configatron.mack.notifier.xmpp.set_default(:jid_resource, 'work')
+configatron.mack.notifier.xmpp.set_default(:password, 'test1234')
+configatron.mack.notifier.xmpp.set_default(:message_type, :chat)
+configatron.mack.notifier.xmpp.set_default(:wait_for_response, true)
+configatron.mack.notifier.xmpp.set_default(:response_wait_time, 20)
+configatron.mack.notifier.xmpp.set_default(:response_message, "ack")

data/lib/mack-notifier/validations.rb

@@ -81,6 +81,10 @@ module Mack
         return true
       end
       
+      def errors_for(name)
+        self.errors.on(name.to_sym)
+      end
+      
     end # Validatable
   end # Notifier
 end # Mack

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mack-notifier
 version: !ruby/object:Gem::Version 
-  version: 0.8.0.101
+  version: 0.8.1
 platform: ruby
 authors: 
 - Mark Bates
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-11 00:00:00 -04:00
+date: 2008-10-26 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,26 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.6.7
     version: 
+- !ruby/object:Gem::Dependency 
+  name: xmpp4r
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: "0.4"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: xmpp4r-simple
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.8.8
+    version: 
 description: Notifier functionality for Mack applications.
 email: mark@mackframework.com
 executables: []
@@ -43,10 +63,12 @@ extra_rdoc_files: []
 files: 
 - lib/mack-notifier/adapters/base.rb
 - lib/mack-notifier/adapters/tmail.rb
+- lib/mack-notifier/adapters/xmpp_msg.rb
 - lib/mack-notifier/attachment.rb
 - lib/mack-notifier/delivery_handlers/sendmail.rb
 - lib/mack-notifier/delivery_handlers/smtp.rb
 - lib/mack-notifier/delivery_handlers/test.rb
+- lib/mack-notifier/delivery_handlers/xmpp_transport.rb
 - lib/mack-notifier/errors.rb
 - lib/mack-notifier/loader.rb
 - lib/mack-notifier/notifier.rb