agent_xmpp 0.1.0

data/lib/agent_xmpp/xmpp/iq_pubsub.rb

@@ -0,0 +1,270 @@
+# Original from XMPP4R - XMPP Library for Ruby Website::http://home.gna.org/xmpp4r/
+##############################################################################################################
+module AgentXmpp
+
+  #####-------------------------------------------------------------------------------------------------------
+  module Xmpp
+
+    #####-------------------------------------------------------------------------------------------------------
+    class IqPubSub < Element
+
+      #.......................................................................................................
+      name_xmlns 'pubsub', 'http://jabber.org/protocol/pubsub'
+      xmpp_child :subscription, :publish
+      
+      #####-------------------------------------------------------------------------------------------------------
+      class << self
+
+        #.........................................................................................................
+        def create_node(pipe, to, node)
+          iq = Xmpp::Iq.new(:set, to)  
+          create = REXML::Element.new('create')
+          create.add_attribute('node', node) 
+          iq.pubsub = IqPubSub.new << create
+          configure = REXML::Element.new('configure')
+          user_config = Publication.find_by_node(node)
+          if user_config
+            form = Xmpp::XData.new(:submit)
+            form.add_field_with_value('FORM_TYPE', 'http://jabber.org/protocol/pubsub#node_config', :hidden)
+            configure << AgentXmpp::DEFAULT_PUBSUB_CONFIG.inject(form) do |f, (var, val)|             
+              f.add_field_with_value("pubsub##{var.to_s}", user_config.send(var) || val)
+            end
+          end
+          iq.pubsub << configure 
+          Send(iq) do |r|
+            if r.type == :result and r.kind_of?(Xmpp::Iq)
+              pipe.broadcast_to_delegates(:on_pubsub_create_node_result, pipe, r, node)
+            elsif r.type.eql?(:error)
+              pipe.broadcast_to_delegates(:on_pubsub_create_node_error, pipe, r, node)
+            end
+          end     
+        end
+
+        #.........................................................................................................
+        def subscriptions(pipe, to)
+          iq = Xmpp::Iq.new(:get, to)
+          iq.pubsub = IqPubSub.new << REXML::Element.new('subscriptions')
+          Send(iq) do |r|
+            if r.type == :result and r.kind_of?(Xmpp::Iq)
+              pipe.broadcast_to_delegates(:on_pubsub_subscriptions_result, pipe, r)
+            elsif r.type.eql?(:error)
+              pipe.broadcast_to_delegates(:on_pubsub_subscriptions_error, pipe, r)
+            end
+          end     
+        end
+
+        #.........................................................................................................
+        def subscribe(pipe, to, node)
+          iq = Xmpp::Iq.new(:set, to)
+          subscribe = REXML::Element.new('subscribe')
+          subscribe.add_attribute('node', node) 
+          subscribe.add_attribute('jid', AgentXmpp.jid.bare.to_s) 
+          iq.pubsub = IqPubSub.new << subscribe
+          Send(iq) do |r|
+            if r.type == :result and r.kind_of?(Xmpp::Iq)
+              pipe.broadcast_to_delegates(:on_pubsub_subscribe_result, pipe, r, node)
+            elsif r.type.eql?(:error)
+              pipe.broadcast_to_delegates(:on_pubsub_subscribe_error, pipe, r, node)
+            end
+          end     
+        end
+
+        #.........................................................................................................
+        def unsubscribe(pipe, to, node)
+          iq = Xmpp::Iq.new(:set, to)
+          unsubscribe = REXML::Element.new('unsubscribe')
+          unsubscribe.add_attribute('node', node) 
+          unsubscribe.add_attribute('jid', AgentXmpp.jid.bare.to_s) 
+          iq.pubsub = IqPubSub.new << unsubscribe
+          Send(iq) do |r|
+            if r.type == :result and r.kind_of?(Xmpp::Iq)
+              pipe.broadcast_to_delegates(:on_pubsub_unsubscribe_result, pipe, r, node)
+            elsif r.type.eql?(:error)
+              pipe.broadcast_to_delegates(:on_pubsub_unsubscribe_error, pipe, r, node)
+            end
+          end     
+        end
+
+        #.........................................................................................................
+        def affiliations(pipe, to)
+          iq = Xmpp::Iq.new(:get, to)
+          iq.pubsub = IqPubSub.new << REXML::Element.new('affiliations')
+          Send(iq) do |r|
+            if r.type == :result and r.kind_of?(Xmpp::Iq)
+              pipe.broadcast_to_delegates(:on_pubsub_affiliations_result, pipe, r)
+            elsif r.type.eql?(:error)
+              pipe.broadcast_to_delegates(:on_pubsub_affiliations_error, pipe, r)
+            end
+          end     
+        end
+
+      #### self
+      end
+     
+      #.........................................................................................................
+      def subscriptions
+        first_element('subscriptions').elements.to_a('subscription')
+      end
+     
+    #### IqPubSub 
+    end
+
+    #####--------------------------------------------------------------------------------------------------------
+    class IqPubSubOwner < Element
+
+      #..........................................................................................................
+      name_xmlns 'pubsub', 'http://jabber.org/protocol/pubsub' + '#owner'
+
+      #####-------------------------------------------------------------------------------------------------------
+      class << self
+
+        #.........................................................................................................
+        def delete_node(pipe, to, node)
+          iq = Xmpp::Iq.new(:set, to)  
+          delete = REXML::Element.new('delete')
+          delete.add_attribute('node', node) 
+          iq.pubsub = IqPubSubOwner.new << delete
+          Send(iq) do |r|
+            if r.type == :result and r.kind_of?(Xmpp::Iq)
+              pipe.broadcast_to_delegates(:on_pubsub_delete_node_result, pipe, r, node)
+            elsif r.type.eql?(:error)
+              pipe.broadcast_to_delegates(:on_pubsub_delete_node_error, pipe, r, node)
+            end
+          end     
+        end
+      
+      #### self
+      end
+
+    end
+
+    #####-------------------------------------------------------------------------------------------------------
+    class IqPublish < Element
+
+      #.........................................................................................................
+      name_xmlns 'publish', 'http://jabber.org/protocol/pubsub'
+      xmpp_attribute :node
+      xmpp_child :item
+
+      #####-------------------------------------------------------------------------------------------------------
+      class << self
+
+        #.........................................................................................................
+        def set(pipe, args)
+          iq = Xmpp::Iq.new(:set, args[:to])
+          item =  Item.new << args[:payload]
+          pub = IqPublish.new("#{AgentXmpp.user_pubsub_root}/#{args[:node]}") << item
+          iq.pubsub = IqPubSub.new << pub
+          Send(iq) do |r|
+            if r.type == :result and r.kind_of?(Xmpp::Iq)
+              pipe.broadcast_to_delegates(:on_publish_result, pipe, r, args[:node])
+            elsif r.type.eql?(:error)
+              pipe.broadcast_to_delegates(:on_publish_error, pipe, r, args[:node])
+            end
+          end     
+        end
+
+      #### self
+      end
+
+      #.........................................................................................................
+      def initialize(node=nil)
+        super()
+        self.node = node if node
+      end
+    end
+
+    #####-------------------------------------------------------------------------------------------------------
+    class Items < Element
+      name_xmlns 'items', 'http://jabber.org/protocol/pubsub'
+      xmpp_attribute :node, :subid, :max_items
+    end
+
+    #####-------------------------------------------------------------------------------------------------------
+    class Item < Element
+      name_xmlns 'item', 'http://jabber.org/protocol/pubsub'
+      xmpp_attribute :id
+      xmpp_child :x, :entry
+      def initialize(id=nil)
+        super()
+        self.id = id if id
+      end
+    end
+
+    #####-------------------------------------------------------------------------------------------------------
+    class Event < Element
+      name_xmlns 'event', 'http://jabber.org/protocol/pubsub' + "#event"
+      def items
+        elements.to_a('items')
+      end
+    end
+
+    #####-------------------------------------------------------------------------------------------------------
+    class EventItems < Items
+      name_xmlns 'items', 'http://jabber.org/protocol/pubsub' + "#event"
+      #.........................................................................................................
+      def item
+        elements.to_a('item')
+      end
+    end
+
+    #####-------------------------------------------------------------------------------------------------------
+    class EventItem < Item
+      name_xmlns 'item', 'http://jabber.org/protocol/pubsub' + "#event"
+    end
+
+    #####-------------------------------------------------------------------------------------------------------
+    class Subscriptions < Element
+      name_xmlns 'subscriptions', 'http://jabber.org/protocol/pubsub'
+    end
+
+    #####-------------------------------------------------------------------------------------------------------
+    class Subscription < Element
+
+      #.........................................................................................................
+      name_xmlns 'subscription', 'http://jabber.org/protocol/pubsub'
+      xmpp_attribute :node, :subid, :subscription
+
+      #.........................................................................................................
+      def initialize(jid=nil, node=nil, subid=nil, state=nil) 
+        super()
+        self.jid = jid if jid
+        self.node = node if node
+        self.subid = subid if subid
+        self.state = state if state
+      end
+
+      #.........................................................................................................
+      def jid
+        (a = attribute('jid')).nil? ? a : Jid.new(a.value)
+      end
+
+      #.........................................................................................................
+      def jid=(myjid)
+        add_attribute('jid', myjid ? myjid.to_s : nil)
+      end
+
+      #.........................................................................................................
+      def state
+        sub = attributes['subscription']
+        ['none', 'pending', 'subscribed', 'unconfigured'].include?(sub) ? sub.to_sym : nil
+      end
+
+      #.........................................................................................................
+      def state=(mystate)
+        attributes['subscription'] = mystate
+      end
+
+      #.........................................................................................................
+      def need_approval?
+        state == :pending
+      end
+      
+    #### Subscription
+    end
+      
+  #### Xmpp
+  end
+
+#### AgentXmpp
+end

data/lib/agent_xmpp/xmpp/iq_roster.rb

@@ -0,0 +1,183 @@
+# Original from XMPP4R - XMPP Library for Ruby Website::http://home.gna.org/xmpp4r/
+##############################################################################################################
+module AgentXmpp
+
+  #####-------------------------------------------------------------------------------------------------------
+  module Xmpp
+
+    #####-------------------------------------------------------------------------------------------------------
+    class IqRoster < IqQuery
+
+      #.......................................................................................................
+      name_xmlns 'query', 'jabber:iq:roster'
+
+      #####-------------------------------------------------------------------------------------------------------
+      class << self
+        
+        #.........................................................................................................
+        def get(pipe)
+          Send(new_rosterget) do |r|
+            if r.type == :result and r.kind_of?(Xmpp::Iq)
+              pipe.broadcast_to_delegates(:on_roster_result, pipe, r)
+            elsif r.type.eql?(:error)
+              raise AgentXmppError, "roster request failed"
+            end
+          end
+        end
+
+        #.........................................................................................................
+        def update(pipe, roster_item_jid, groups=nil)
+          request = new_rosterset
+          item = Xmpp::RosterItem.new(roster_item_jid)
+          item.groups = groups unless groups.nil?
+          request.query.add(item)
+          Send(request) do |r|
+            if r.type == :result and r.kind_of?(Xmpp::Iq)
+              pipe.broadcast_to_delegates(:on_update_roster_item_result, pipe, roster_item_jid)
+            elsif r.type.eql?(:error)
+              pipe.broadcast_to_delegates(:on_update_roster_item_error, pipe, roster_item_jid)
+            end
+          end
+        end
+
+        #.........................................................................................................
+        def remove(pipe, roster_item_jid)
+          request = new_rosterset
+          request.query.add(Xmpp::RosterItem.new(roster_item_jid, nil, :remove))
+          Send(request) do |r|
+            if r.type == :result and r.kind_of?(Xmpp::Iq)
+              pipe.broadcast_to_delegates(:on_remove_roster_item_result, pipe, roster_item_jid)
+            elsif r.type.eql?(:error)
+              pipe.broadcast_to_delegates(:on_remove_roster_item_error, pipe, roster_item_jid)
+            end
+          end
+        end
+        
+      private 
+      
+        #.......................................................................................................
+        def new_rosterget
+          iq = Iq.new(:get)
+          query = IqQuery.new
+          query.add_namespace('jabber:iq:roster')
+          iq.add(query)
+          iq
+        end
+        
+        #.......................................................................................................
+        def new_rosterset
+          iq = Iq.new(:set)
+          query = IqQuery.new
+          query.add_namespace('jabber:iq:roster')
+          iq.add(query)
+          iq
+        end
+        
+      #### self
+      end
+
+      #.......................................................................................................
+      def each(&block)
+        each_element {|item| yield(item) if item.kind_of?(RosterItem)}
+      end
+
+      #.......................................................................................................
+      def [](jid)
+        each{|item| return(item) if item.jid == jid}
+        nil
+      end
+
+      #.......................................................................................................
+      def to_a
+        a = []
+        each{|item| a.push(item)}
+        a
+      end
+
+      #.......................................................................................................
+      def receive_iq(iq, filter=true)
+        return if filter && (((iq.type != :set) && (iq.type != :result)) || (iq.queryns != 'jabber:iq:roster'))
+        import(iq.query)
+      end
+
+      #.......................................................................................................
+      def inspect
+        jids = to_a.collect { |item| item.jid.inspect }
+        jids.join(', ')
+      end
+      
+    #### IqQueryRoster
+    end
+
+    #####-------------------------------------------------------------------------------------------------------
+    class RosterItem < Element
+
+      #.......................................................................................................
+      name_xmlns 'item', 'jabber:iq:roster'
+      xmpp_attribute :subscription, :sym => true
+
+      #.......................................................................................................
+      def initialize(jid=nil, iname=nil, subscription=nil, ask=nil)
+        super()
+        self.jid = jid
+        self.iname = iname if iname
+        self.subscription = subscription if subscription
+        self.ask = ask if ask
+      end
+
+      #.......................................................................................................
+      def iname
+        attributes['name']
+      end
+
+      #.......................................................................................................
+      def iname=(val)
+        attributes['name'] = val
+      end
+
+      #.......................................................................................................
+      def jid
+        (a = attributes['jid']) ? Jid.new(a) : nil
+      end
+
+      #.......................................................................................................
+      def jid=(val)
+        attributes['jid'] = val.nil? ? nil : val.to_s
+      end
+
+      #.......................................................................................................
+      def ask
+        case attributes['ask']
+          when 'subscribe' then :subscribe
+          else :none
+        end
+      end
+
+      #.......................................................................................................
+      def ask=(val)
+        case val
+          when :subscribe then attributes['ask'] = 'subscribe'
+          else attributes['ask'] = nil
+        end
+      end
+
+      #.......................................................................................................
+      def groups
+        elements.inject('group', []) {|r, g| r << g.text}.uniq
+      end
+
+      #.......................................................................................................
+      def groups=(ary)
+        delete_elements('group')
+        ary.uniq.each{|group| add_element('group').text = group}
+      end
+      
+    #### RosterItem
+    end
+    
+  #### XMPP
+  end
+
+#### AgentXmpp
+end
+