class Blather::JID

Jabber ID or JID

See [RFC 3920 Section 3 - Addressing](xmpp.org/rfcs/rfc3920.html#addressing)

An entity is anything that can be considered a network endpoint (i.e., an ID on the network) and that can communicate using XMPP. All such entities are uniquely addressable in a form that is consistent with RFC 2396 [URI]. For historical reasons, the address of an XMPP entity is called a Jabber Identifier or JID. A valid JID contains a set of ordered elements formed of a domain identifier, node identifier, and resource identifier.

The syntax for a JID is defined below using the Augmented Backus-Naur Form as defined in [ABNF]. (The IPv4address and IPv6address rules are defined in Appendix B of [IPv6]; the allowable character sequences that conform to the node rule are defined by the Nodeprep profile of [STRINGPREP] as documented in Appendix A of this memo; the allowable character sequences that conform to the resource rule are defined by the Resourceprep profile of [STRINGPREP] as documented in Appendix B of this memo; and the sub-domain rule makes reference to the concept of an internationalized domain label as described in [IDNA].)

jid             = [ node "@" ] domain [ "/" resource ]
domain          = fqdn / address-literal
fqdn            = (sub-domain 1*("." sub-domain))
sub-domain      = (internationalized domain label)
address-literal = IPv4address / IPv6address

All JIDs are based on the foregoing structure. The most common use of this structure is to identify an instant messaging user, the server to which the user connects, and the user's connected resource (e.g., a specific client) in the form of <user@host/resource>. However, node types other than clients are possible; for example, a specific chat room offered by a multi-user chat service could be addressed as <room@service> (where “room” is the name of the chat room and “service” is the hostname of the multi-user chat service) and a specific occupant of such a room could be addressed as <room@service/nick> (where “nick” is the occupant's room nickname). Many other JID types are possible (e.g., <domain/resource> could be a server-side script or service).

Each allowable portion of a JID (node identifier, domain identifier, and resource identifier) MUST NOT be more than 1023 bytes in length, resulting in a maximum total size (including the '@' and '/' separators) of 3071 bytes.

Constants

PATTERN

Validating pattern for JID string

Attributes

domain[R]
node[R]
resource[R]

Public Class Methods

new(node, domain = nil, resource = nil) click to toggle source

@private

Calls superclass method
# File lib/blather/jid.rb, line 57
def self.new(node, domain = nil, resource = nil)
  node.is_a?(JID) ? node : super
end
new(node, domain = nil, resource = nil) click to toggle source

Create a new JID object

@overload initialize(jid)

Passes the jid object right back out
@param [Blather::JID] jid a jid object

@overload initialize(jid)

Creates a new JID parsed out of the provided jid
@param [String] jid a jid in the standard format
("node@domain/resource")

@overload initialize(node, domain = nil, resource = nil)

Creates a new JID
@param [String] node the node of the JID
@param [String, nil] domian the domain of the JID
@param [String, nil] resource the resource of the JID

@raise [ArgumentError] if the parts of the JID are too large (1023 bytes) @return [Blather::JID] a new jid object

# File lib/blather/jid.rb, line 77
def initialize(node, domain = nil, resource = nil)
  @resource = resource
  @domain = domain
  @node = node

  if @domain.nil? && @resource.nil?
    @node, @domain, @resource = @node.to_s.scan(PATTERN).first
  end

  raise ArgumentError, 'Node too long' if (@node || '').length > 1023
  raise ArgumentError, 'Domain too long' if (@domain || '').length > 1023
  raise ArgumentError, 'Resource too long' if (@resource || '').length > 1023
end

Public Instance Methods

<=>(other) click to toggle source

Compare two JIDs, helpful for sorting etc.

String representations are compared, see JID#to_s

@param [#to_s] other a JID to comare against @return [Fixnum<-1, 0, 1>]

# File lib/blather/jid.rb, line 128
def <=>(other)
  to_s.downcase <=> other.to_s.downcase
end
strip!() click to toggle source

Removes the resource (sets it to nil)

@return [Blather::JID] the JID without a resource

# File lib/blather/jid.rb, line 117
def strip!
  @resource = nil
  self
end
stripped() click to toggle source

Returns a new JID with resource removed.

@return [Blather::JID] a new JID without a resource

# File lib/blather/jid.rb, line 110
def stripped
  dup.strip!
end
stripped?() click to toggle source

Test if JID is stripped

@return [true, false]

# File lib/blather/jid.rb, line 136
def stripped?
  @resource.nil?
end
to_s() click to toggle source

Turn the JID into a string

  • “”

  • “domain”

  • “node@domain”

  • “domain/resource”

  • “node@domain/resource”

@return [String] the JID as a string

# File lib/blather/jid.rb, line 100
def to_s
  s = @domain
  s = "#{@node}@#{s}" if @node
  s = "#{s}/#{@resource}" if @resource
  s
end