/lib/vendor/xmpp4r/test/caps/tc_helper.rb

$:.unshift File::dirname(__FILE__) + '/../../lib'

require 'test/unit'
require File::dirname(__FILE__) + '/../lib/clienttester'

require 'xmpp4r/discovery'
require 'xmpp4r/caps/helper/helper'
require 'xmpp4r/dataforms'
include Jabber

class Caps::HelperTest < Test::Unit::TestCase
  include ClientTester

  ##
  # Walk through the client/ server conversation defined
  # in http://www.xmpp.org/extensions/xep-0115.html#usecases
  # and assert conformance.
  def test_caps_reply
    # This will be invoked by 'wait_state' below...
    state { |presence|
      assert_kind_of(Jabber::Presence, presence)
      c = presence.first_element('c')
      assert_kind_of(Jabber::Caps::C, c)

      # see http://www.xmpp.org/extensions/xep-0115.html#ver
      assert_equal('SrFo9ar2CCk2EnOH4q4QANeuxLQ=', c.ver)

      # version 1.5 of xep 0115 indicates that the <c /> stanzq MUST feature a 'hash' attribute
      assert_equal('sha-1', c.hash)

      assert_equal("http://home.gna.org/xmpp4r/##{Jabber::XMPP4R_VERSION}", c.node)

      send(iq_discovering_capabilities)
    }

    # Construct Caps::Helper which will send a <presence>
    # stanza (with embedded <c/> advert) to the 'server'
    h = Caps::Helper.new(@client, identities, features)

    # The 'server' will receive the <presence> stanza and
    # yield it to the 'state' block above, where an <iq> query
    # will be sent back to the 'client,' to discover its capabilities.
    # Wait here until the block has been executed.
    wait_state

    # The Caps::Helper will process the <iq> query from the 'server'
    # and reply with an <iq> result providing the details of its
    # identities and features.

    state { |iq|
      assert_kind_of(Jabber::Iq, iq)
      assert_equal(:result, iq.type)
      assert_equal('1867999907', iq.id)
      assert_equal('new-big-computer.local', iq.to.to_s)

      assert_kind_of(Jabber::Discovery::IqQueryDiscoInfo, iq.query)
      assert_equal(iq.query.identities.size, identities.size)
      get_category_iname_type = lambda{ |i| [i.category,i.iname,i.type] }
      assert_equal(iq.query.identities.map(&get_category_iname_type).sort!, identities.map(&get_category_iname_type).sort!)

      assert_equal(3, iq.query.features.size)
      get_var = lambda { |f| f.var }
      assert_equal(iq.query.features.sort, features.map(&get_var).sort)
    }

    # The 'server' will receive the <iq> result from the
    # 'client' and yield it to the block above. Wait here
    # until that block exits.
    wait_state
  end

  def test_custom_node
    client_id='http://new-big-computer.local/client#321'

    state { |presence|
      c = presence.first_element('c')
      assert_kind_of(Jabber::Caps::C, c)
      assert_equal(client_id, c.node)
      assert_equal('SrFo9ar2CCk2EnOH4q4QANeuxLQ=', c.ver)
    }
    h = Caps::Helper.new(@client, identities, features, client_id)
    wait_state
  end

  def identities
    [Jabber::Discovery::Identity.new('client', 'Exodus 0.9.1', 'pc')]
  end

  def features
    [Jabber::Discovery::Feature.new("http://jabber.org/protocol/disco#info"),
     Jabber::Discovery::Feature.new("http://jabber.org/protocol/disco#items"),
     Jabber::Discovery::Feature.new("http://jabber.org/protocol/muc")]
  end

  def iq_discovering_capabilities
    "<iq from='new-big-computer.local' type='get' to='matt@new-big-computer.local/capable_client' id='1867999907' xmlns='jabber:client'><query xmlns='http://jabber.org/protocol/disco#info'/></iq>"
  end

  ##
  # http://www.xmpp.org/extensions/xep-0115.html#ver-gen-complex
  def test_caps_complex
    form = Dataforms::XData.new(:result)
    form.add(Dataforms::XDataField.new('FORM_TYPE', :hidden)).value = 'urn:xmpp:dataforms:softwareinfo'
    form.add(Dataforms::XDataField.new('ip_version')).values = ['ipv4', 'ipv6']
    form.add(Dataforms::XDataField.new('software')).value = 'Psi' # re-ordered
    form.add(Dataforms::XDataField.new('software_version')).value = '0.11'
    form.add(Dataforms::XDataField.new('os')).value = 'Mac'
    form.add(Dataforms::XDataField.new('os_version')).value = '10.5.1'
    ver = Caps::generate_ver([Discovery::Identity.new('client', 'Psi 0.9.1', 'pc').set_xml_lang('en'),
                              Discovery::Identity.new('client', 'Ψ 0.9.1', 'pc').set_xml_lang('el')],
                             [Discovery::Feature.new('http://jabber.org/protocol/muc'), # re-ordered
                              Discovery::Feature.new('http://jabber.org/protocol/disco#info'),
                              Discovery::Feature.new('http://jabber.org/protocol/disco#items')],
                             [form])
    assert_equal('8lu+88MRxmKM7yO3MEzY7YmTsWs=', ver)
  end

  ##
  # http://www.xmpp.org/extensions/xep-0115.html#ver-gen-complex
  def test_caps_complex_imported
    query = IqQuery::import(REXML::Document.new(<<END).root)
<query xmlns='http://jabber.org/protocol/disco#info'
         node='http://psi-im.org#8lu+88MRxmKM7yO3MEzY7YmTsWs='>
    <identity xml:lang='en' category='client' name='Psi 0.9.1' type='pc'/>
    <identity xml:lang='el' category='client' name='Ψ 0.9.1' type='pc'/>
    <feature var='http://jabber.org/protocol/disco#info'/>
    <feature var='http://jabber.org/protocol/disco#items'/>
    <feature var='http://jabber.org/protocol/muc'/>
    <x xmlns='jabber:x:data' type='result'>
      <field var='FORM_TYPE' type='hidden'>
        <value>urn:xmpp:dataforms:softwareinfo</value>
      </field>
      <field var='ip_version'>
        <value>ipv4</value>
        <value>ipv6</value>
      </field>
      <field var='os'>
        <value>Mac</value>
      </field>
      <field var='os_version'>
        <value>10.5.1</value>
      </field>
      <field var='software'>
        <value>Psi</value>
      </field>
      <field var='software_version'>
        <value>0.11</value>
      </field>
    </x>
  </query>
END
    assert_equal('8lu+88MRxmKM7yO3MEzY7YmTsWs=',
                 Caps::generate_ver_from_discoinfo(query))
  end
end