xmpp4r 0.3.2 → 0.4

data/lib/xmpp4r/tune/tune.rb

@@ -0,0 +1,113 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+
+require 'xmpp4r/xmppelement'
+require 'rexml/element'
+
+module Jabber
+  module UserTune
+    NS_USERTUNE = 'http://jabber.org/protocol/tune'
+
+    ##
+    # The <tune> XMPP element, as defined in XEP-0118 User Tune
+    #
+    # See http://www.xmpp.org/extensions/xep-0118.html - this element
+    # encapsulates metadata (artist, track etc) about a tune the user
+    # is currently playing. These are expressed as child elements
+    # such as <artist>, <title> etc which are also managed by this class.
+    #
+    # If the element has no children then it indicates that the user
+    # has stopped playing a tune. Use the Tune#playing? method to discover
+    # this?
+    class Tune < XMPPElement
+      name_xmlns 'tune', NS_USERTUNE
+      force_xmlns true
+
+      ##
+      # Construct a new <tune> element.
+      #
+      # Supply no arguments to make an
+      # empty element to indicate that tune playing has stopped.
+      #
+      # artist:: [String] the artist or performer of the song or piece
+      # title:: [String] the title of the song or piece
+      # length:: [Fixnum] the duration of the song or piece in seconds
+      # track:: [String] a unique identifier for the tune; e.g., the track number within a collection or the specific URI for the object (e.g., a stream or audio file)
+      # source:: [String] the collection (e.g., album) or other source (e.g., a band website that hosts streams or audio files)
+      # uri:: [String] a URI or URL pointing to information about the song, collection, or artist
+      # rating:: [Numeric] a number indicating how much you like this song - will be clamped into an integer 0 <= x <= 10
+      def initialize(artist = nil, title = nil, length = nil, track = nil, source = nil, uri = nil, rating = nil)
+        super()
+
+        add_element(REXML::Element.new('artist')).text = artist if artist
+
+        add_element(REXML::Element.new('title')).text = title if title
+
+        add_element(REXML::Element.new('length')).text = length.to_s if length
+
+        add_element(REXML::Element.new('track')).text = track if track
+
+        add_element(REXML::Element.new('source')).text = source if source
+
+        add_element(REXML::Element.new('uri')).text = uri if uri
+
+        if rating and rating.kind_of?(Numeric)
+          r = rating.to_i
+          r = 0 if r < 0
+          r = 10 if r > 10
+          add_element(REXML::Element.new('rating')).text = r.to_s
+        end
+      end
+
+
+      ##
+      # Returns true if a tune is currently playing, otherwise false.
+      def playing?
+        (elements.size > 0)
+      end
+
+      ##
+      # Get the artist for this tune.
+      def artist
+        first_element('artist').text if first_element('artist')
+      end
+
+      ##
+      # Get the title of this tune.
+      def title
+        first_element('title').text  if first_element('title')
+      end
+
+      ##
+      # Get the length of this tune, in seconds.
+      def length
+        first_element('length').text.to_i if first_element('length')
+      end
+
+      ##
+      # Get an identitier for this tune.
+      def track
+        first_element('track').text if first_element('track')
+      end
+
+      ##
+      # Get the source of this tune, such as an album.
+      def source
+        first_element('source').text if first_element('source')
+      end
+
+      ##
+      # Get a URI that represents this tune.
+      def uri
+        first_element('uri').text if first_element('uri')
+      end
+
+      ##
+      # Get the rating for this track
+      def rating
+        first_element('rating').text.to_i if first_element('rating')
+      end
+    end
+  end
+end

data/lib/xmpp4r/vcard.rb

@@ -4,4 +4,3 @@
 
 require 'xmpp4r/vcard/helper/vcard.rb'
 require 'xmpp4r/vcard/iq/vcard.rb'
-

data/lib/xmpp4r/vcard/helper/vcard.rb

@@ -3,7 +3,6 @@
 # Website::http://home.gna.org/xmpp4r/
 
 require 'xmpp4r/iq'
-require 'xmpp4r/errorexception'
 
 module Jabber
   module Vcard
@@ -20,7 +19,7 @@ module Jabber
       # Retrieve vCard of an entity
       #
       # Raises exception upon retrieval error, please catch that!
-      # (The exception is ErrorException and is raisen by
+      # (The exception is ServerError and is raisen by
       # Stream#send_with_id.
       #
       # Usage of Threads is suggested here as vCards can be very
@@ -83,4 +82,3 @@ module Jabber
     end
   end
 end
-

data/lib/xmpp4r/vcard/iq/vcard.rb

@@ -3,6 +3,7 @@
 # Website::http://home.gna.org/xmpp4r/
 
 require 'xmpp4r/iq'
+require 'xmpp4r/base64'
 
 module Jabber
   module Vcard
@@ -72,6 +73,19 @@ module Jabber
         element_names(self).uniq
       end
 
+      ##
+      # Get the PHOTO/BINVAL (Avatar picture) field decoded from Base64
+      # result:: [String] or [nil]
+      def photo_binval
+        if (binval = self['PHOTO/BINVAL'])
+          Base64::decode64(binval)
+        else
+          nil
+        end
+      end
+
+      private
+
       ##
       # Recursive helper function,
       # returns all element names in an array, concatenated

data/lib/xmpp4r/version/iq/version.rb

@@ -103,4 +103,3 @@ module Jabber
     end
   end
 end
-

data/lib/xmpp4r/x.rb

@@ -25,7 +25,7 @@ module Jabber
       if wanted_xmlns.kind_of? Class and wanted_xmlns.ancestors.include? XMPPElement
         wanted_xmlns = wanted_xmlns.new.namespace
       end
-      
+
         each_element('x') { |x|
         if wanted_xmlns.nil? or wanted_xmlns == x.namespace
           return x

data/lib/xmpp4r/xhtml.rb

@@ -0,0 +1 @@
+require 'xmpp4r/xhtml/html'

data/lib/xmpp4r/xhtml/html.rb

@@ -0,0 +1,115 @@
+require 'xmpp4r/xmppelement'
+
+module Jabber
+  module XHTML
+    NS_XHTML_IM = 'http://jabber.org/protocol/xhtml-im'
+    NS_XHTML = 'http://www.w3.org/1999/xhtml'
+
+    ##
+    # XHTML-IM (XEP-0071) container
+    #
+    # The important methods are:
+    # * HTML#contents=
+    # * HTML#to_text
+    class HTML < XMPPElement
+      name_xmlns 'html', NS_XHTML_IM
+      force_xmlns true
+
+      ##
+      # Initialize element with HTML contents (see HTML#contents=)
+      def initialize(contents=[])
+        super()
+        self.contents = contents
+      end
+
+      ##
+      # Get first XHTML::Body child
+      def body
+        first_element('body') || add(Body.new)
+      end
+
+      ##
+      # Replace first XHTML::Body child
+      def body=(body)
+        delete_elements('body')
+        add(body)
+      end
+
+      ##
+      # Replace first XHTML::Body child (chainable)
+      def set_body(body)
+        self.body = body
+        self
+      end
+
+      ##
+      # Set contents of this HTML document. The "contents" parameter can be:
+      # * An Array of REXML::Element and Strings which will replace the current children of the body
+      # * A single REXML::Element which will replace all other children of the body
+      # * An instance of XHTML::Body which will replace the current body
+      # * A String comprising an HTML fragment. This will be parsed, which could raise an Exception.
+      #   We must never send invalid XML over an XMPP stream. If you intend to put variable data in
+      #   your HTML, use something like Rails' Builder::XmlMarkup or Ramaze::Gestalt
+      def contents=(contents)
+        if contents.kind_of? String
+          self.body = REXML::Document.new("<body xmlns='#{NS_XHTML}'>#{contents}</body>").root
+        elsif contents.kind_of? Body
+          self.body = contents
+        elsif contents.kind_of? Array
+          self.body = Body.new
+          contents.each do |element|
+            if element.kind_of? String
+              body.add_text(element)
+            else
+              body.add(element)
+            end
+          end
+        else
+          self.body = Body.new
+          body.add(contents)
+        end
+      end
+
+      ##
+      # HTML#contents= chainable
+      def set_contents(contents)
+        self.contents = contents
+        self
+      end
+
+      ##
+      # Convert contents of this XHTML container to plain text
+      # for easy usage with an additional fall-back <body/> in message stanzas
+      #
+      # The resulting string is recursively composed of the text nodes of
+      # all children.
+      # This works because of the design criteria of HTML/XHTML:
+      # readable content is not being put into attributes but as text children.
+      #
+      # If you require clickable links and proper information representation
+      # then compose the text yourself!
+      def to_text
+        text_getter = nil # Create binding so that the following lambda can work recursively
+
+        text_getter = lambda do |element|
+          if element.kind_of? REXML::Text
+            element.value
+          elsif element.kind_of? REXML::Element
+            element.children.collect { |child|
+              text_getter.call(child)
+            }.join
+          end
+        end
+
+        text_getter.call(self) # Finally, execute and return results
+      end
+    end
+
+    ##
+    # HTML Body element, must be the only child of XHTML::HTML
+    class Body < XMPPElement
+      name_xmlns 'body', NS_XHTML
+      force_xmlns true
+    end
+  end
+end

data/lib/xmpp4r/xmpp4r.rb

@@ -3,14 +3,16 @@
 # Website::http://home.gna.org/xmpp4r/
 
 ##
-# The Jabber module is the root namespace of the library. You might want
-# to Include it in your script to ease your coding. It provides
-# a simple debug logging support.
+# The Jabber module is the root namespace of the library.
 module Jabber
-  # XMPP4R Version number
-  XMPP4R_VERSION = '0.3.2'
+  # XMPP4R Version number.  This is the ONLY place where the version number
+  # should be specified.  This constant is used to determine the version of
+  # package tarballs and generated gems.
+  XMPP4R_VERSION = '0.4'
 end
 
 require 'xmpp4r/client'
 require 'xmpp4r/component'
 require 'xmpp4r/debuglog'
+require 'xmpp4r/errors'
+

data/lib/xmpp4r/xmppelement.rb

@@ -5,11 +5,6 @@
 require 'xmpp4r/rexmladdons'
 
 module Jabber
-  class NoNameXmlnsRegistered < RuntimeError
-    def initialize(klass)
-      super "Class #{klass} has not set name and xmlns"
-    end
-  end
 
   ##
   # This class represents an XML element and provides functionality
@@ -148,5 +143,26 @@ module Jabber
       cloned.context = @context
       cloned
     end
+
+    ##
+    # Generic XML attribute 'xml:lang'
+    # (REXML provides no shortcut)
+    def xml_lang
+      attributes['xml:lang']
+    end
+
+    ##
+    # Set XML language attribute
+    def xml_lang=(l)
+      attributes['xml:lang'] = l
+    end
+
+    ##
+    # Set XML language attribute (chainable)
+    def set_xml_lang(l)
+      self.xml_lang = l
+      self
+    end
+
   end
 end

data/lib/xmpp4r/xmppstanza.rb

@@ -3,7 +3,7 @@
 # Website::http://home.gna.org/xmpp4r/
 
 require 'xmpp4r/xmppelement'
-require 'xmpp4r/error'
+require 'xmpp4r/errors'
 require 'xmpp4r/jid'
 
 module Jabber
@@ -28,7 +28,7 @@ module Jabber
     # import:: [true or false] Copy attributes and children of source
     # result:: [XMPPStanza] answer stanza
     def XMPPStanza.answer(xmppstanza, import=true)
-      x = xmppstanza.class::new
+      x = xmppstanza.class.new
       if import
         x.import(xmppstanza)
       end
@@ -64,7 +64,7 @@ module Jabber
     #
     # return:: [String] the element's to attribute
     def to
-      (a = attribute('to')).nil? ? a : JID::new(a.value)
+      (a = attribute('to')).nil? ? a : JID.new(a.value)
     end
 
     ##
@@ -89,7 +89,7 @@ module Jabber
     #
     # return:: [String] the element's from attribute
     def from
-      (a = attribute('from')).nil? ? a : JID::new(a.value)
+      (a = attribute('from')).nil? ? a : JID.new(a.value)
     end
 
     ##
@@ -122,7 +122,7 @@ module Jabber
     #
     # v:: [String] the value id set
     def id= (v)
-      add_attribute('id', v)
+      add_attribute('id', v.to_s)
     end
 
     ##
@@ -130,7 +130,7 @@ module Jabber
     #
     # v:: [String] the value id set
     def set_id(v)
-      add_attribute('id', v)
+      add_attribute('id', v.to_s)
       self
     end
 

data/setup.rb

@@ -660,7 +660,7 @@ module FileOperations
   def ruby(*args)
     command config('rubyprog'), *args
   end
-  
+
   def make(task = nil)
     command(*[config('makeprog'), task].compact)
   end
@@ -723,7 +723,7 @@ module HookScriptAPI
   def srcdirectory?(path)
     File.dir?(srcfile(path))
   end
-  
+
   def srcfile?(path)
     File.file?(srcfile(path))
   end
@@ -827,7 +827,7 @@ class ToplevelInstaller
       __send__ "exec_#{task}"
     end
   end
-  
+
   def run_metaconfigs
     @config.load_script "#{@ardir}/metaconfig"
   end
@@ -1405,7 +1405,7 @@ class Installer
   end
 
   # picked up many entries from cvs-1.11.1/src/ignore.c
-  JUNK_FILES = %w( 
+  JUNK_FILES = %w(
     core RCSLOG tags TAGS .make.state
     .nse_depinfo #* .#* cvslog.* ,* .del-* *.olb
     *~ *.old *.bak *.BAK *.orig *.rej _$* *$