agent_xmpp 0.1.0

data/lib/agent_xmpp/xmpp/entry.rb

@@ -0,0 +1,36 @@
+##############################################################################################################
+module AgentXmpp
+
+  #####-------------------------------------------------------------------------------------------------------
+  module Xmpp
+
+    #####-------------------------------------------------------------------------------------------------------
+    class Entry < Element
+
+      #.....................................................................................................
+      name_xmlns 'entry', 'http://www.w3.org/2005/Atom'
+
+      #.......................................................................................................
+      def initialize(t = nil)
+        super()
+        add_element(REXML::Element.new("title").add_text(t)) if t
+      end
+
+      #.......................................................................................................
+      def title
+        first_element_text('title')
+      end
+
+      #.......................................................................................................
+      def title=(t)
+        replace_element_text('title', t)
+      end
+
+    #### Entry
+    end
+
+  #### XMPP
+  end
+
+#### AgentXmpp
+end

data/lib/agent_xmpp/xmpp/error_response.rb

@@ -0,0 +1,189 @@
+# Original from XMPP4R - XMPP Library for Ruby Website::http://home.gna.org/xmpp4r/
+##############################################################################################################
+module AgentXmpp
+
+  #####-------------------------------------------------------------------------------------------------------
+  module Xmpp
+
+    #####-------------------------------------------------------------------------------------------------------
+    class NoNameXmlnsRegistered < ArgumentError
+      def initialize(klass)
+        super "Class #{klass} has not set name and xmlns"
+      end
+    end
+
+    #####-------------------------------------------------------------------------------------------------------
+    class ErrorResponse < Element
+
+      #.........................................................................................................
+      name_xmlns 'error'
+      xmpp_attribute :type, :sym => true
+
+      #####-------------------------------------------------------------------------------------------------------
+      class << self
+        
+        #.........................................................................................................
+        def bad_request(params, msg)
+          command_error(params, 'bad-request', msg)
+        end
+
+        #.........................................................................................................
+        def unsupported_payload(params)
+          command_error(params, 'bad-request', 'unsupported payload')
+        end
+
+        #.........................................................................................................
+        def no_route(params)
+          command_error(params, 'item-not-found', 'no route for specified command node')
+        end
+
+        #.........................................................................................................
+        def forbidden(params)
+          command_error(params, 'forbidden', 'the requesting JID is not allowed to execute the command')
+        end
+
+        #.........................................................................................................
+        def feature_not_implemented(request)
+          iq_error(request, 'feature-not-implemented', 'feature not implemented')
+        end
+
+        #.........................................................................................................
+        def service_unavailable(request)
+          query_error(request, 'service-unavailable', 'service unavailable')
+        end
+
+        #.........................................................................................................
+        def item_not_found(request)
+          query_error(request, 'item-not-found', 'item not found')
+        end
+
+      ####........................................................................................................
+      private
+
+        #.........................................................................................................
+        def iq_error(request, condition, text)
+          iq = Xmpp::Iq.new(:error, request.from)
+          iq.id = request.id unless request.id.nil?
+          iq.error = Xmpp::ErrorResponse.new(condition, text)
+          Send(iq)
+        end
+
+        #.........................................................................................................
+        def query_error(request, condition, text)
+          iq = Xmpp::Iq.new(:error, request.from)
+          iq.id = request.id unless request.id.nil?
+          iq.query = Xmpp::IqQuery.new
+          iq.query.add_namespace(request.query.namespace)
+          iq.query.attributes['node'] = request.query.node if request.query.respond_to?(:node) and request.query.node
+          iq.error = Xmpp::ErrorResponse.new(condition, text)
+          Send(iq)
+        end
+
+        #.........................................................................................................
+        def command_error(params, condition, text)
+          iq = Xmpp::Iq.new(:error, params[:from])
+          iq.id = params[:id] unless params[:id].nil?
+          iq.command = Xmpp::IqCommand.new(params[:node], params[:action])
+          iq.command = Xmpp::ErrorResponse.new(condition, text)
+          Send(iq)
+        end
+      
+      #### self
+      end
+
+      #.......................................................................................................
+      def initialize(errorcondition=nil, text=nil)
+        if errorcondition.nil?
+          super()
+        else
+          errortype = nil
+          errorcode = nil
+          @@Errors.each do |cond,type,code|
+            if errorcondition == cond
+              errortype = type
+              errorcode = code
+            end
+          end
+          raise ArgumentError, "Unknown error condition when initializing ErrorReponse" if errortype.nil? || errorcode.nil?
+          super()
+          self.error = errorcondition unless errorcondition.nil?
+          self.type = errortype unless errortype.nil?
+          self.code = errorcode unless errorcode.nil?
+        end
+        self.text = text unless text.nil?
+      end
+
+      #.......................................................................................................
+      def code
+        (c = attributes['code']).nil? ? nil : c.to_i
+      end
+
+      #.......................................................................................................
+      def code=(i)
+        attributes['code'] = i.nil? ? nil : i.to_s
+      end
+
+      #.......................................................................................................
+      def error
+        name = nil
+        each_element {|e| name = e.name if (e.namespace == 'urn:ietf:params:xml:ns:xmpp-stanzas') && (e.name != 'text') }
+        name
+      end
+
+      #.......................................................................................................
+      def error=(s)
+        xe = nil
+        each_element {|e| xe = e if (e.namespace == 'urn:ietf:params:xml:ns:xmpp-stanzas') && (e.name != 'text') }
+        unless xe.nil?
+          delete_element(xe)
+        end
+        add_element(s).add_namespace('urn:ietf:params:xml:ns:xmpp-stanzas')
+      end
+
+      #.......................................................................................................
+      def text
+        first_element_text('text') || super
+      end
+
+      #.......................................................................................................
+      def text=(s)
+        delete_elements('text')
+        unless s.nil?
+          e = add_element('text')
+          e.add_namespace('urn:ietf:params:xml:ns:xmpp-stanzas')
+          e.text = s
+        end
+      end
+
+      #.......................................................................................................
+      @@Errors = [['bad-request', :modify, 400],
+                  ['conflict', :cancel, 409],
+                  ['feature-not-implemented', :cancel, 501],
+                  ['forbidden', :auth, 403],
+                  ['gone', :modify, 302],
+                  ['internal-server-error', :wait, 500],
+                  ['item-not-found', :cancel, 404],
+                  ['jid-malformed', :modify, 400],
+                  ['not-acceptable', :modify, 406],
+                  ['not-allowed', :cancel, 405],
+                  ['not-authorized', :auth, 401],
+                  ['payment-required', :auth, 402],
+                  ['recipient-unavailable', :wait, 404],
+                  ['redirect', :modify, 302],
+                  ['registration-required', :auth, 407],
+                  ['remote-server-not-found', :cancel, 404],
+                  ['remote-server-timeout', :wait, 504],
+                  ['resource-constraint', :wait, 500],
+                  ['service-unavailable', :cancel, 503],
+                  ['subscription-required', :auth, 407],
+                  ['undefined-condition', nil, 500],
+                  ['unexpected-request', :wait, 400]]
+                  
+    #### ErrorResponse
+    end
+    
+  #### XMPP
+  end
+
+#### AgentXmpp
+end

data/lib/agent_xmpp/xmpp/iq.rb

@@ -0,0 +1,90 @@
+# Original from XMPP4R - XMPP Library for Ruby Website::http://home.gna.org/xmpp4r/
+##############################################################################################################
+module AgentXmpp
+
+  #####-------------------------------------------------------------------------------------------------------
+  module Xmpp
+
+    #####-------------------------------------------------------------------------------------------------------
+    class Iq < Stanza
+
+      #.....................................................................................................
+      name_xmlns 'iq', 'jabber:client'
+      xmpp_child :query, :error, :pubsub, :command, :bind, :session
+
+      #####-----------------------------------------------------------------------------------------------------
+      class << self
+        
+        #.........................................................................................................
+        def bind(pipe)
+          iq = new_bind(AgentXmpp.jid)
+          Send(iq) do |r|
+            if r.type == :result and full_jid = r.first_element('//jid') and full_jid.text
+              AgentXmpp.jid = Jid.new(full_jid.text)                
+              pipe.broadcast_to_delegates(:on_bind, pipe)
+            elsif r.type.eql?(:error) and r.bind
+              raise AgentXmppError, "resource bind failed"
+            end
+          end
+        end
+
+        #.........................................................................................................
+        def session(pipe)
+          iq = new_session
+          Send(iq) do |r|
+            if r.type == :result                
+              pipe.broadcast_to_delegates(:on_start_session, pipe)
+            elsif r.type.eql?(:error) and r.session
+              raise AgentXmppError, "session start failed"
+            end
+          end
+        end
+      
+      private
+        
+        #.......................................................................................................
+        def new_bind(jid)
+          iq = Iq.new(:set)
+          iq.bind = REXML::Element.new('bind')
+          iq.bind.add_namespace('urn:ietf:params:xml:ns:xmpp-bind')                
+          resource = iq.bind.add(REXML::Element.new('resource'))
+          resource.text = jid.resource
+          iq
+        end
+
+        #.......................................................................................................
+        def new_session
+          iq = Iq.new(:set)
+          iq.session =REXML::Element.new('session')
+          iq.session.add_namespace('urn:ietf:params:xml:ns:xmpp-session')
+          iq
+        end
+      
+      #### self
+      end
+
+      #.......................................................................................................
+      def initialize(type = nil, to = nil)
+        super()
+        self.to = to unless to.nil?
+        self.type = type unless type.nil?
+      end
+
+      #.......................................................................................................
+      def queryns
+        (e = first_element('query')).nil? ? nil : e.namespace
+      end
+
+    #### Iq
+    end
+
+    #####-------------------------------------------------------------------------------------------------------
+    class IqQuery < Element
+      name_xmlns 'query'
+    end
+
+  #### XMPP
+  end
+
+#### AgentXmpp
+end

data/lib/agent_xmpp/xmpp/iq_command.rb

@@ -0,0 +1,54 @@
+# Original from XMPP4R - XMPP Library for Ruby Website::http://home.gna.org/xmpp4r/
+##############################################################################################################
+module AgentXmpp
+
+  #####-------------------------------------------------------------------------------------------------------
+  module Xmpp
+
+    #####-------------------------------------------------------------------------------------------------------
+    class IqCommand < Element
+
+      #.....................................................................................................
+      name_xmlns 'command', 'http://jabber.org/protocol/commands'
+      xmpp_attribute :node, :sessionid
+      xmpp_attribute :action, :status, :sym => true
+      xmpp_child :actions, :x
+
+      #####-------------------------------------------------------------------------------------------------------
+      class << self
+        
+        #.........................................................................................................
+        def send_command(args, &blk)
+          iq = Xmpp::Iq.new(args[:iq_type] || :set, args[:to])
+          iq.id = args[:id] unless args[:id].nil?
+          iq.command = new(args[:node])
+          iq.command.action = args[:action] unless args[:action].nil? 
+          iq.command.status = args[:status] unless args[:status].nil? 
+          iq.command.sessionid = args[:sessionid] unless args[:sessionid].nil?
+          iq.command << args[:payload] unless args[:payload].nil?
+          if blk
+            Send(iq) do |r|  
+              AgentXmpp.logger.info "RECEIVED RESPONSE: #{r.type} from #{r.from}"
+              blk.call(r.type, (r.type.eql?(:result) and r.command and r.command.x) ? r.command.x.to_native : nil)
+            end
+          else; Send(iq); end               
+        end
+        
+      #### self
+      end
+
+      #.....................................................................................................
+      def initialize(node=nil, action=nil)
+        super()
+        self.node = node if node
+        self.action = action if action
+      end
+
+    #### IqCommand
+    end
+
+  #### XMPP
+  end
+  
+#### AgentXmpp
+end

data/lib/agent_xmpp/xmpp/iq_disco.rb

@@ -0,0 +1,206 @@
+# Original from XMPP4R - XMPP Library for Ruby Website::http://home.gna.org/xmpp4r/
+##############################################################################################################
+module AgentXmpp
+
+  #####-------------------------------------------------------------------------------------------------------
+  module Xmpp
+
+    #####-------------------------------------------------------------------------------------------------------
+    class IqDiscoItems < IqQuery
+
+      #.........................................................................................................
+      name_xmlns 'query', 'http://jabber.org/protocol/disco#items'
+      xmpp_attribute :node
+
+      #####-----------------------------------------------------------------------------------------------------
+      class << self
+
+        #.........................................................................................................
+        def get(pipe, to=nil, node=nil)
+          iq = Iq.new(:get, to)
+          iq.query = new
+          iq.query.node = node if node
+          Send(iq) do |r|
+            if (r.type == :result) && r.query.kind_of?(Xmpp::IqDiscoItems)
+              pipe.broadcast_to_delegates(:on_discoitems_result, pipe, r)
+            elsif r.type.eql?(:error)
+              pipe.broadcast_to_delegates(:on_discoitems_error, pipe, r)
+            end
+          end
+        end
+        
+        #.........................................................................................................
+        def result(pipe, request)
+          iq = Xmpp::Iq.new(:result, request.from.to_s)
+          iq.id = request.id unless request.id.nil?
+          iq.query = new
+          Send(iq)
+        end
+
+        #.........................................................................................................
+        def result_command_nodes(pipe, request)
+          from_jid = request.from.to_s
+          iq = Xmpp::Iq.new(:result, from_jid)
+          iq.id = request.id unless request.id.nil?
+          iq.query = new
+          iq.query.node = 'http://jabber.org/protocol/commands'
+          iq.query.items = BaseController.command_nodes(from_jid).map{|n| {:node => n, :name => n.humanize, :jid => AgentXmpp.jid.to_s}}
+          Send(iq)
+        end
+
+      #### self
+      end
+
+      #.........................................................................................................
+      def items
+        elements.to_a('item')
+      end
+
+      #.........................................................................................................
+      def items=(its)
+        its.each{|i| self << DiscoItem.new(i[:jid], i[:name], i[:node])}
+      end
+
+    #### IqDiscoItems
+    end
+
+    #####-------------------------------------------------------------------------------------------------------
+    class IqDiscoInfo < IqQuery
+
+      #.........................................................................................................
+      name_xmlns 'query', 'http://jabber.org/protocol/disco#info'
+      xmpp_attribute :node
+
+      #####-------------------------------------------------------------------------------------------------------
+      class << self
+
+        #.........................................................................................................
+        def get(pipe, to=nil, node=nil)
+          iq = Iq.new(:get, to)
+          iq.query = new
+          iq.query.node = node if node
+          Send(iq) do |r|
+            if (r.type == :result) && r.query.kind_of?(Xmpp::IqDiscoInfo)
+              pipe.broadcast_to_delegates(:on_discoinfo_result, pipe, r)
+            elsif r.type.eql?(:error)
+              pipe.broadcast_to_delegates(:on_discoinfo_error, pipe, r)
+            end
+          end
+        end
+        
+        #.........................................................................................................
+        def result(pipe, request)
+          iq = Xmpp::Iq.new(:result, request.from.to_s)
+          iq.id = request.id unless request.id.nil?
+          iq.query = IqDiscoInfo.new
+          iq.query << DiscoIdentity.new(AgentXmpp::IDENTITY[:category], AgentXmpp::IDENTITY[:name], AgentXmpp::IDENTITY[:type])
+          iq.query.features = AgentXmpp::FEATURES
+          Send(iq)
+        end
+        
+      #### self  
+      end
+      
+      #.........................................................................................................
+      def identities
+        elements.to_a('identity')
+      end
+
+      #.........................................................................................................
+      def features
+        elements.to_a('feature')
+      end
+  
+      #.........................................................................................................
+      def features=(feats)
+        feats.each{|f| self << DiscoFeature.new(f)}
+      end
+  
+    #### IqDiscoInfo
+    end
+
+    #####-------------------------------------------------------------------------------------------------------
+    class DiscoItem < Element
+
+      #.........................................................................................................
+      name_xmlns 'item', 'http://jabber.org/protocol/disco#items'
+      xmpp_attribute :node
+
+      #.........................................................................................................
+      def initialize(jid=nil, iname=nil, node=nil)
+        super()
+        self.jid = jid if jid
+        self.iname = iname if iname
+        self.node = node if node
+      end
+
+      #.........................................................................................................
+      def jid
+        Jid.new(attributes['jid'])
+      end
+
+      #.........................................................................................................
+      def jid=(val)
+        attributes['jid'] = val.to_s
+      end
+
+      def iname
+        attributes['name']
+      end
+
+      #.........................................................................................................
+      def iname=(val)
+        attributes['name'] = val
+      end
+
+    #### DiscoItem
+    end
+
+    #####-------------------------------------------------------------------------------------------------------
+    class DiscoIdentity < Element
+
+      #.........................................................................................................
+      name_xmlns 'identity', 'http://jabber.org/protocol/disco#info'
+      xmpp_attribute :node, :category, :type
+
+      #.........................................................................................................
+      def initialize(category=nil, iname=nil, type=nil)
+        super()
+        self.category = category if category
+        self.iname = iname if iname
+        self.type = type if type
+      end
+
+      def iname
+        attributes['name']
+      end
+
+      #.........................................................................................................
+      def iname=(val)
+        attributes['name'] = val
+      end
+
+    #### DiscoIdentity 
+    end
+
+    #####-------------------------------------------------------------------------------------------------------
+    class DiscoFeature < Element
+
+      #.........................................................................................................
+      name_xmlns 'feature', 'http://jabber.org/protocol/disco#info'
+      xmpp_attribute :var
+
+      #.........................................................................................................
+      def initialize(var=nil)
+        super()
+        self.var = var
+      end
+
+    #### DiscoFeature  
+    end
+    
+  #### Xmpp
+  end
+  
+#### AgentXmpp
+end