aastra_xml_api 1.0.0 → 1.0.1

data/lib/aastra_xml_api/phone_text_screen.rb

@@ -0,0 +1,95 @@
+################################################################################
+# Aastra XML API Classes - PhoneTextScreen
+# Copyright Aastra Telecom 2008
+#
+# Ruby adaptation by Carlton O'Riley
+#
+# PhoneTextScreen object.
+#
+# Public methods
+#
+# Inherited from Phone
+#     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 'PhoneTextScreen.rb'
+#     text = PhoneTextScreen.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
+#
+################################################################################
+
+module AastraXmlApi
+  class PhoneTextScreen < Phone
+    @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 = "<PhoneTextScreen"
+      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 += "</PhoneTextScreen>\n"
+      return xml
+    end
+  end
+end

data/lib/aastra_xml_api/version.rb

@@ -1,3 +1,3 @@
 module AastraXmlApi
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aastra_xml_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Emery A. Miller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-11 00:00:00.000000000 Z
+date: 2014-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -32,37 +32,38 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - aastra_xml_api.gemspec
 - lib/aastra_xml_api.rb
-- lib/aastra_xml_api/AastraIPPhone.rb
-- lib/aastra_xml_api/AastraIPPhoneConfiguration.rb
-- lib/aastra_xml_api/AastraIPPhoneConfigurationEntry.rb
-- lib/aastra_xml_api/AastraIPPhoneDirectory.rb
-- lib/aastra_xml_api/AastraIPPhoneDirectoryEntry.rb
-- lib/aastra_xml_api/AastraIPPhoneExecute.rb
-- lib/aastra_xml_api/AastraIPPhoneExecuteEntry.rb
-- lib/aastra_xml_api/AastraIPPhoneFormattedTextScreen.rb
-- lib/aastra_xml_api/AastraIPPhoneFormattedTextScreenEntry.rb
-- lib/aastra_xml_api/AastraIPPhoneGDImage.rb
-- lib/aastra_xml_api/AastraIPPhoneIconEntry.rb
-- lib/aastra_xml_api/AastraIPPhoneImageMenu.rb
-- lib/aastra_xml_api/AastraIPPhoneImageMenuEntry.rb
-- lib/aastra_xml_api/AastraIPPhoneImageScreen.rb
-- lib/aastra_xml_api/AastraIPPhoneInputScreen.rb
-- lib/aastra_xml_api/AastraIPPhoneInputScreenEntry.rb
-- lib/aastra_xml_api/AastraIPPhoneSoftkeyEntry.rb
-- lib/aastra_xml_api/AastraIPPhoneStatus.rb
-- lib/aastra_xml_api/AastraIPPhoneStatusEntry.rb
-- lib/aastra_xml_api/AastraIPPhoneTextMenu.rb
-- lib/aastra_xml_api/AastraIPPhoneTextMenuEntry.rb
-- lib/aastra_xml_api/AastraIPPhoneTextScreen.rb
-- lib/aastra_xml_api/arraynatsort.rb
+- lib/aastra_xml_api/array_extensions.rb
+- lib/aastra_xml_api/phone.rb
+- lib/aastra_xml_api/phone_configuration.rb
+- lib/aastra_xml_api/phone_configuration_entry.rb
+- lib/aastra_xml_api/phone_directory.rb
+- lib/aastra_xml_api/phone_directory_entry.rb
+- lib/aastra_xml_api/phone_execute.rb
+- lib/aastra_xml_api/phone_execute_entry.rb
+- lib/aastra_xml_api/phone_formatted_text_screen.rb
+- lib/aastra_xml_api/phone_formatted_text_screen_entry.rb
+- lib/aastra_xml_api/phone_gd_image.rb
+- lib/aastra_xml_api/phone_icon_entry.rb
+- lib/aastra_xml_api/phone_image_menu.rb
+- lib/aastra_xml_api/phone_image_menu_entry.rb
+- lib/aastra_xml_api/phone_image_screen.rb
+- lib/aastra_xml_api/phone_input_screen.rb
+- lib/aastra_xml_api/phone_input_screen_entry.rb
+- lib/aastra_xml_api/phone_softkey_entry.rb
+- lib/aastra_xml_api/phone_status.rb
+- lib/aastra_xml_api/phone_status_entry.rb
+- lib/aastra_xml_api/phone_text_menu.rb
+- lib/aastra_xml_api/phone_text_menu_entry.rb
+- lib/aastra_xml_api/phone_text_screen.rb
 - lib/aastra_xml_api/version.rb
-homepage: http://www.easyofficephone.com
+homepage: https://github.com/EasyOfficePhone/aastra_xml_api
 licenses:
 - GNU GPL v2
 metadata: {}
@@ -82,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Aastra XML API for Ruby

data/lib/aastra_xml_api/AastraIPPhone.rb

@@ -1,203 +0,0 @@
-###############################################################################
-# Aastra XML API Classes - AastraIPPhone
-# Copyright Aastra Telecom 2008
-#
-# Ruby adaptation by Carlton O'Riley
-#
-# AastraIPPhone is the root class for all the Aastra XML objects.
-#
-# Public methods
-#     setTitle(Title) to setup the title of an object (optional)
-#     setTitleWrap to set the title to be wrapped on 2 lines (optional)
-#     setCancelAction(uri) to set the cancel parameter with the URI to be called on Cancel (optional)
-#     setDestroyOnExit to set DestroyonExit parameter to 'yes', 'no' by default (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 soktkeys to the object (optional)
-#     setRefresh(timeout,URL) to add Refresh parameters to the object (optional)
-#     addIcon(index,icon) to add custom icons to the object (optional)
-#
-###############################################################################
-
-class AastraIPPhone
-  @entries
-  @softkeys
-  @icons
-  @title
-  @title_wrap
-  @destroyOnExit
-  @cancelAction
-  @refreshTimeout
-  @refreshURL
-  @beep
-  @lockin
-  @timeout
-  @allowAnswer
-
-  HIGHASCII = {
-    "!\xc0!" => 'A',    # A`
-    "!\xe0!" => 'a',    # a`
-    "!\xc1!" => 'A',    # A'
-    "!\xe1!" => 'a',    # a'
-    "!\xc2!" => 'A',    # A^
-    "!\xe2!" => 'a',    # a^
-    "!\xc4!" => 'Ae',   # A:
-    "!\xe4!" => 'ae',   # a:
-    "!\xc3!" => 'A',    # A~
-    "!\xe3!" => 'a',    # a~
-    "!\xc8!" => 'E',    # E`
-    "!\xe8!" => 'e',    # e`
-    "!\xc9!" => 'E',    # E'
-    "!\xe9!" => 'e',    # e'
-    "!\xca!" => 'E',    # E^
-    "!\xea!" => 'e',    # e^
-    "!\xcb!" => 'Ee',   # E:
-    "!\xeb!" => 'ee',   # e:
-    "!\xcc!" => 'I',    # I`
-    "!\xec!" => 'i',    # i`
-    "!\xcd!" => 'I',    # I'
-    "!\xed!" => 'i',    # i'
-    "!\xce!" => 'I',    # I^
-    "!\xee!" => 'i',    # i^
-    "!\xcf!" => 'Ie',   # I:
-    "!\xef!" => 'ie',   # i:
-    "!\xd2!" => 'O',    # O`
-    "!\xf2!" => 'o',    # o`
-    "!\xd3!" => 'O',    # O'
-    "!\xf3!" => 'o',    # o'
-    "!\xd4!" => 'O',    # O^
-    "!\xf4!" => 'o',    # o^
-    "!\xd6!" => 'Oe',   # O:
-    "!\xf6!" => 'oe',   # o:
-    "!\xd5!" => 'O',    # O~
-    "!\xf5!" => 'o',    # o~
-    "!\xd8!" => 'Oe',   # O/
-    "!\xf8!" => 'oe',   # o/
-    "!\xd9!" => 'U',    # U`
-    "!\xf9!" => 'u',    # u`
-    "!\xda!" => 'U',    # U'
-    "!\xfa!" => 'u',    # u'
-    "!\xdb!" => 'U',    # U^
-    "!\xfb!" => 'u',    # u^
-    "!\xdc!" => 'Ue',   # U:
-    "!\xfc!" => 'ue',   # u:
-    "!\xc7!" => 'C',    # ,C
-    "!\xe7!" => 'c',    # ,c
-    "!\xd1!" => 'N',    # N~
-    "!\xf1!" => 'n',    # n~
-    "!\xdf!" => 'ss'
-  }
-
-  # Create an AastraIPPhone object and set initial values. Everything
-  # sent to the phone will inherit from this class.
-  def initialize
-    @entries = []
-    @softkeys = []
-    @icons = []
-    @refreshTimeout = 0
-    @timeout = 0
-  end
-
-  # Set the title of the AastraIPPhone object.  Typically displayed on the
-  # top of the phone.
-  def setTitle(title)
-    @title = title
-  end
-
-  # Allow the title to wrap over multiple lines when displayed.
-  def setTitleWrap
-    @title_wrap = "yes"
-  end
-
-  # Set refresh timeout (seconds) and the URI to load when the
-  # timeout is reached.
-  def setRefresh(timeout, url)
-    @refreshTimeout = timeout
-    @refreshURL = url
-  end
-
-  # Beep phone when XML is received.
-  def setBeep
-    @beep = "yes"
-  end
-
-  # Do not keep the object in the phone browser after exit.
-  def setDestroyOnExit
-    @destroyOnExit = "yes"
-  end
-
-  # Defines the URI to call when the user cancels the XML object.
-  def setCancelAction(cancelAction)
-    @cancelAction = cancelAction
-  end
-
-  # Ignores all keys that would cause the screen to exit without using
-  # keys defined by the object.
-  def setLockIn
-    @lockin = "yes"
-  end
-
-  # Override the default 45 second timeout.  A value of 0 will disable
-  # timeout.
-  def setTimeout(timeout)
-    @timeout = timeout
-  end
-
-  # Applies only to the non-softkey phones (53i).  When set, the phone
-  # displays 'Ignore' and 'Answer' if the XML object is displayed when
-  # the phone is ringing.
-  def setAllowAnswer
-    @allowAnswer = "yes"
-  end
-
-  # Returns the set refresh timeout value.
-  def getRefreshTimeout
-    return @refreshTimeout
-  end
-
-  # Returns the set refresh URI.
-  def getRefreshURL
-    return @refreshURL
-  end
-
-  # Add a softkey to be displayed while the XML object is on the screen.
-  # Only available on the 9480i, 9480iCT, 55i, 57i, and 57iCT.  Softkey
-  # will be at position index.  label is what is displayed next to the
-  # softkey button.  uri is what is called when the softkey is pressed.
-  # Optionally, icon is the index of the icon to display to the left of
-  # the label.
-  def addSoftkey(index, label, uri, icon=nil)
-    @softkeys += [AastraIPPhoneSoftkeyEntry.new(index, escape(label), escape(uri), icon)]
-  end
-
-  # Add an icon to be used by either a softkey of AastraIPPhoneTextMenu.
-  # Only available on the 55i, 57i, and 57iCT. The index is the same as
-  # what is referenced by addSoftkey or AastraIPPhoneTextMenu.addEntry.
-  # The icon can be either a predefined icon or the hex of an icon image.
-  def addIcon(index, icon)
-    @icons += [AastraIPPhoneIconEntry.new(index, icon)]
-  end
-
-  # Convert any HTML characters to the proper escaped format.
-  # i.e. > becomes >
-  def escape(s)
-    return nil if s.nil?
-    CGI.escapeHTML(s)
-  end
-
-  # Convert characters when using double sized text in
-  # AastraIPPhoneFormattedTextScreen.
-  def convert_high_ascii(s)
-    ret = ""
-    s.each do |char|
-      if not HIGHASCII[char].nil? then
-        ret += HIGHASCII[char]
-      else
-        ret += char
-      end
-    end
-    return ret
-  end
-  end

data/lib/aastra_xml_api/AastraIPPhoneConfiguration.rb

@@ -1,55 +0,0 @@
-################################################################################
-# Aastra XML API Classes - AastraIPPhoneConfiguration
-# Copyright Aastra Telecom 8007
-#
-# Ruby adaptation by Carlton O'Riley
-#
-# AastraIPPhoneConfiguration object.
-#
-# Public methods
-#
-# Inherited from AastraIPPhone
-#     setBeep to enable a notification beep with the object (optional)
-#
-# Specific to the object
-#     addEntry(parameter,value) to add a configuration change.
-#     setTriggerDestroyOnExit to set the triggerDestroyOnExit tag to
-#     "yes" (optional)
-#
-# Example
-#     require 'AastraIPPhoneConfiguration.rb'
-#     configuration = AastraIPPhoneConfiguration.new
-#     configuration.addEntry('softkey1 label','Test')
-#     configuration.addEntry('softkey1 type','xml')
-#     configuration.setTriggerDestroyOnExit
-#     configuration.setBeep
-#     aastra_output configuration
-#
-################################################################################
-
-class AastraIPPhoneConfiguration < AastraIPPhone
-
-  # Adds a parameter and value entry to the list.
-  def addEntry(parameter, value)
-    @entries += [AastraIPPhoneConfigurationEntry.new(parameter, value)]
-  end
-
-  # When set, the previous user interface XML object is destroyed
-  # if its destroyOnExit tag is also set to yes.
-  def setTriggerDestroyOnExit
-    @triggerDestroyOnExit = "yes"
-  end
-
-  # Create XML text output.
-  def render
-    out = "<AastraIPPhoneConfiguration"
-    out += " Beep=\"yes\"" if @beep == "yes"
-    out += " triggerDestroyOnExit=\"yes\"" if @triggerDestroyOnExit == "yes"
-    out += ">\n"
-    @entries.each do |entry|
-      out += entry.render
-    end
-    out += "</AastraIPPhoneConfiguration>\n"
-    return out
-  end
-  end