aastra_xml_api 1.0.0 → 1.0.1

data/lib/aastra_xml_api/AastraIPPhoneTextMenu.rb

@@ -1,145 +0,0 @@
-################################################################################
-# Aastra XML API Classes - AastraIPPhoneTextMenu
-# Copyright Aastra Telecom 2008
-#
-# AastraIPPhoneTextMenu object.
-#
-# Public methods
-#
-# Inherited from AastraIPPhone
-#     setTitle(Title) to setup the title of an object (optional)
-#     setTitleWrap to set the title to be wrapped on 2 lines (optional)
-#     setDestroyOnExit to set DestroyOnExit parameter to "yes" (optional)
-#     setCancelAction(uri) to set the cancel parameter with the URI to be called on Cancel (optional)
-#     setBeep to enable a notification beep with the object (optional)
-#     setLockIn to set the Lock-in tag to 'yes' (optional)
-#     setAllowAnswer to set the allowAnswer tag to 'yes' (optional)
-#     setTimeout(timeout) to define a specific timeout for the XML object (optional)
-#     addSoftkey(index,label,uri,icon_index) to add custom softkeys to the object (optional)
-#     addIcon(index,icon) to add custom icons to the object (optional)
-#     setRefresh(timeout,URL) to add Refresh parameters to the object (optional)
-#
-# Specific to the object
-#     setDefaultIndex(index) to set the default selection in the list (optional)
-#     setStyle(style) to set the style of the list numbered/none/radio (optional)
-#     setWrapList to allow 2 lines items (optional)
-#     addEntry(name,url,selection,icon,dial) to add an element in the list to be displayed
-#     natsortbyname to order the list
-#
-# Example 1
-#    require 'AastraIPPhoneTextMenu.rb'
-#    menu = AastraIPPhoneTextMenu.new
-#    menu.setTitle('Title')
-#    menu.setDestroyOnExit
-#    menu.setDeFaultIndex('3')
-#    menu.addEntry('Choice 2', 'http://myserver.com/script.php?choice=2', 'Value=2')
-#    menu.addEntry('Choice 1', 'http://myserver.com/script.php?choice=1', 'Value=1')
-#    menu.addEntry('Choice 3', 'http://myserver.com/script.php?choice=3', 'Value=3')
-#    menu.natsortByName
-#    menu.addSoftkey('1', 'My Select', 'http://myserver.com/script.php?action=1')
-#    menu.addSoftkey('6', 'Exit', 'SoftKey:Exit')
-#    aastra_output menu
-#
-# Example 2
-#    require 'AastraIPPhoneTextMenu.rb'
-#    menu = AastraIPPhoneTextMenu.new
-#    menu.setTitle('Title')
-#    menu.setDestroyOnExit
-#    menu.setDeFaultIndex('2')
-#    menu.addEntry('Choice 2', 'http://myserver.com/script.php?choice=2', 'Value=2','1')
-#    menu.addEntry('Choice 1', 'http://myserver.com/script.php?choice=1', 'Value=1','2')
-#    menu.addEntry('Choice 3', 'http://myserver.com/script.php?choice=3', 'Value=3','3')
-#    menu.natsortByName
-#    menu.addSoftkey('1', 'My Select', 'http://myserver.com/script.php?action=1')
-#    menu.addSoftkey('6', 'Exit', 'SoftKey:Exit')
-#    menu.addIcon('1', 'Icon:PhoneOnHook')
-#    menu.addIcon('2', 'Icon:PhoneOffHook')
-#    menu.addIcon('3', 'Icon:PhoneRinging')
-#    aastra_output menu
-#
-################################################################################
-
-class AastraIPPhoneTextMenu < AastraIPPhone
-  @defaultIndex
-  @style
-  @wraplist
-  @maxitems
-
-  # Sets the default index to highlight when first shown.
-  def setDefaultIndex(defaultIndex)
-    @defaultIndex = defaultIndex
-  end
-
-  # Set the style to one of numbered (default), none, or radio.
-  def setStyle(style)
-    @style = style
-  end
-
-  # Add a menu entry with name displayed and calls url when selected.  The
-  # selection option is the value appended to a custom softkey URL when
-  # this item is highlighted. icon is a reference to an included icon
-  # that is shown with the menu entry.  dial is what is called when
-  # the user hits a softkey with the URI "SoftKey:Dial2".
-  def addEntry(name, url, selection=nil, icon=nil, dial=nil)
-    @entries += [AastraIPPhoneTextMenuEntry.new(name, url, selection, icon, dial)]
-  end
-
-  # Allows entries in the list to wrap.
-  def setWrapList
-    @wraplist = "yes"
-  end
-
-  # Use natural order sorting to sort the menu by name.
-  def natsortByName
-    tmparray = []
-    linklist = {}
-    for i in 0..@entries.size-1
-      tmparray += [@entries[i].getName]
-      linklist[@entries[i].getName] = i
-    end
-    tmparray.natsort!
-    newentries = []
-    tmparray.each do |name|
-      newentries += [@entries[linklist[name]]]
-    end
-    @entries = newentries
-  end
-
-  # Create XML text output.
-  def render
-    @maxitems = 30 if @maxitems.nil?
-    xml = "<AastraIPPhoneTextMenu"
-    xml += " destroyOnExit=\"yes\"" if @destroyOnExit == "yes"
-    xml += " cancelAction=\"#{escape(@cancelAction)}\"" if not @cancelAction.nil?
-    xml += " defaultIndex=\"#{@defaultIndex}\"" if not @defaultIndex.nil?
-    xml += " style=\"#{@style}\"" if not @style.nil?
-    xml += " Beep=\"yes\"" if @beep == "yes"
-    xml += " LockIn=\"yes\"" if @lockin == "yes"
-    xml += " wrapList=\"yes\"" if @wraplist == "yes"
-    xml += " allowAnswer=\"yes\"" if @allowAnswer == "yes"
-    xml += " Timeout=\"#{@timeout}\"" if @timeout != 0
-    xml += ">\n"
-    if not @title.nil? then
-      xml += "<Title"
-      xml += " wrap=\"yes\"" if @title_wrap == "yes"
-      xml += ">#{escape(@title)}</Title>\n"
-    end
-    index = 0
-    @entries.each do |entry|
-      xml += entry.render if index < @maxitems
-      index += 1
-    end
-    @softkeys.each { |softkey| xml += softkey.render }
-    iconList = 0
-    @icons.each do |icon|
-      if iconList == 0 then
-        xml += "<IconList>\n"
-        iconList = 1
-      end
-      xml += icon.render
-    end
-    xml += "</IconList>\n" if iconList != 0
-    xml += "</AastraIPPhoneTextMenu>\n"
-    return xml
-  end
-  end

data/lib/aastra_xml_api/AastraIPPhoneTextMenuEntry.rb

@@ -1,52 +0,0 @@
-################################################################################
-# Aastra XML API Classes - AastraIPPhoneTextMenuEntry
-# Copyright Aastra Telecom 2008
-#
-# Ruby adaptation by Carlton O'Riley
-#
-# Internal class for AastraIPPhoneTextMenu object.
-################################################################################
-
-class AastraIPPhoneTextMenuEntry < AastraIPPhone
-  @name
-  @url
-  @selection
-  @icon
-  @dial
-
-  # Create new text menu entry with given name to be displayed, url to be
-  # called when selected. Selection is the value appended to a custom URI
-  # attached to a softkey.  This will be added as either ?selection=value
-  # or &selection=value depending on if the URI already has parameters.
-  # icon is the index of the icon to be displayed to the left of the
-  # given entry.  dial is the number to call if the user pushes a softkey
-  # with URI SoftKey:Dial2.
-  def initialize(name, url, selection, icon, dial)
-    @name = name
-    @url = url
-    @selection = selection
-    @icon = icon
-    @dial = dial
-    @selection = nil if @selection == ''
-    @icon = nil if @icon == ''
-    @dial = nil if @dial == ''
-  end
-
-  # Returns the name associated with this entry.
-  def getName
-    return @name
-  end
-
-  # Create XML text output of this entry.
-  def render
-    xml = "<MenuItem"
-    xml += " icon=\"#{@icon}\"" if not @icon.nil?
-    xml += ">\n"
-    xml += "<Prompt>#{escape(@name)}</Prompt>\n"
-    xml += "<URI>#{escape(@url)}</URI>\n"
-    xml += "<Selection>#{escape(@selection)}</Selection>\n" if not @selection.nil?
-    xml += "<Dial>#{@dial}</Dial>\n" if not @dial.nil?
-    xml += "</MenuItem>\n"
-    return xml
-  end
-  end

data/lib/aastra_xml_api/AastraIPPhoneTextScreen.rb

@@ -1,93 +0,0 @@
-################################################################################
-# Aastra XML API Classes - AastraIPPhoneTextScreen
-# Copyright Aastra Telecom 2008
-#
-# Ruby adaptation by Carlton O'Riley
-#
-# AastraIPPhoneTextScreen object.
-#
-# Public methods
-#
-# Inherited from AastraIPPhone
-#     setTitle(Title) to setup the title of an object (optional)
-#     setTitleWrap to set the title to be wrapped on 2 lines (optional)
-#     setDestroyOnExit to set DestroyonExit parameter to 'yes', 'no' by default (optional)
-#     setCancelAction(uri) to set the cancel parameter with the URI to be called on Cancel (optional)
-#     setBeep to enable a notification beep with the object (optional)
-#     setLockIn to set the Lock-in tag to 'yes' (optional)
-#     setAllowAnswer to set the allowAnswer tag to 'yes' (optional)
-#     setTimeout(timeout) to define a specific timeout for the XML object (optional)
-#     addSoftkey(index,label,uri,iconindex) to add custom softkeys to the object (optional)
-#     addIcon(index,icon) to add custom icons to the object (optional)
-#     setRefresh(timeout,URL) to add Refresh parameters to the object (optional)
-#
-# Specific to the object
-#     setText(text) to set the text to be displayed.
-#     setDoneAction(uri) to set the URI to be called when the user selects the default "Done" key (optional)
-#     setAllowDTMF to allow DTMF passthrough on the object
-#
-# Example
-#     require 'AastraIPPhoneTextScreen.rb'
-#     text = AastraIPPhoneTextScreen.new
-#     text.setTitle('Title')
-#     text.setText('Text to be displayed.')
-#     text.setDestroyOnExit
-#     text.addSoftkey('1', 'Mail', 'http://myserver.com/script.php?action=1', '1')
-#     text.addSoftkey('6', 'Exit', 'SoftKey:Exit')
-#     text.addIcon('1', 'Icon:Envelope')
-#     aastra_output text
-#
-################################################################################
-
-class AastraIPPhoneTextScreen < AastraIPPhone
-  @text
-  @doneAction
-  @allowDTMF
-
-  # Set the text to be displayed on this screen.
-  def setText(text)
-    @text = text
-  end
-
-  # Set the URI to be called when done viewing this screen.
-  def setDoneAction(uri)
-    @doneAction = uri
-  end
-
-  # When set allows DTMF tones to be sent while viewing this screen.
-  def setAllowDTMF
-    @allowDTMF = "yes"
-  end
-
-  # Create XML text output.
-  def render
-    xml = "<AastraIPPhoneTextScreen"
-    xml += " destroyOnExit=\"yes\"" if @destroyOnExit == "yes"
-    xml += " cancelAction=\"#{escape(@cancelAction)}\"" if not @cancelAction.nil?
-    xml += " doneAction=\"#{escape(@doneAction)}\"" if not @doneAction.nil?
-    xml += " Beep=\"yes\"" if @beep == "yes"
-    xml += " Timeout=\"#{@timeout}\"" if @timeout != 0
-    xml += " LockIn=\"yes\"" if @lockin == "yes"
-    xml += " allowAnswer=\"yes\"" if @allowAnswer == "yes"
-    xml += " allowDTMF=\"yes\"" if @allowDTMF == "yes"
-    xml += ">\n"
-    if not @title.nil? then
-      xml += "<Title"
-      xml += " wrap=\"yes\"" if @title_wrap == "yes"
-      xml += ">#{escape(@title)}</Title>\n"
-    end
-    xml += "<Text>#{escape(@text)}</Text>\n"
-    @softkeys.each { |softkey| xml += softkey.render }
-    iconList = 0
-    @icons.each do |icon|
-      if iconList == 0 then
-        xml += "<IconList>\n"
-        iconList = 1
-      end
-      xml += icon.render
-    end
-    xml += "</IconList>\n" if iconList != 0
-    xml += "</AastraIPPhoneTextScreen>\n"
-    return xml
-  end
-  end

data/lib/aastra_xml_api/arraynatsort.rb

@@ -1,63 +0,0 @@
-# Performs natural order sorting of an array. Natural order is the way in
-# which a human might sort a list of files that are incremented by
-# one.  They will sort normally as long as they have leading zeros,
-# however this doesn't look good and is hard to read.  What natural sorting
-# does is allow the following to be sorted properly (as shown):
-#
-# file1
-# file2
-# file4
-# file22
-# file30
-# file100
-#
-# Code used is from http://zijab.blogspot.com/2007/05/natural-order-string-comparison-for.html
-#
-
-class Array
-
-  # Method which sort an array composed of strings with embedded numbers by
-  # the 'natural' representation of numbers inside a string.
-  def natsort
-
-    reg_number = /\d+/
-
-      # We call the sort method of the Array class.
-      self.sort do |str1, str2|
-
-      # We try to find an embedded number
-      a = str1.match(reg_number)
-      b = str2.match(reg_number)
-
-      # If there is no number
-      if [a,b].include? nil
-        str1 <=> str2
-      else
-        while true
-          begin
-            # We compare strings before the number. If there
-            # are equal, we will have to compare the numbers
-            if (comp = a.pre_match <=> b.pre_match) == 0
-              # If the numbers are equal
-              comp = (a[0] == b[0]) ? comp = a[0] + a.post_match <=> b[0] + b.post_match :
-                comp = a[0].to_i <=> b[0].to_i
-            end
-
-            str1, str2 = a.post_match, b.post_match
-            a = str1.match(reg_number)
-            b = str2.match(reg_number)
-          rescue
-            break
-          end
-        end
-        comp
-      end
-      end
-  end
-
-  # Same as 'natsort' but replace in place.
-  def natsort!
-    self.replace(natsort)
-  end
-
-end