aastra_xml_api 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bdfab2badeb3a0ec06a7d17c125e4fc25b6c1fd
-  data.tar.gz: 70242cc1664caf673ceed9a495a88ace8944151a
+  metadata.gz: 55581e915fa9f7488d01c00c2e7c5c905a9e3571
+  data.tar.gz: 141e8a8e320e51387d4d3db2fcea9fe0333fbf04
 SHA512:
-  metadata.gz: 8212b7d387e28cffbeb403e44788a580dfa2117191d99a7ba7ae2f329a657fda2814fc2a320f4c6b5855d35b0ec6211aa2ec2d7d0dfdc0a53804ec5fb9804aa1
-  data.tar.gz: 7fe764cdfc7d60d670bb44a6ab6b7897bacb5a2414b999d55732ffc9ee58ff6b669b88312c9c58887ac69d8f322894f96237657522b426d2e5e398ab4fbd5d7b
+  metadata.gz: 893884155ef0485bd46524f21a3ad083d4365dc0462d2e0768ab14106b5a52695a92cf059e8b6794bbddd06075bd204bc4ca7c29d4a951b45bd32a61f9c22f4c
+  data.tar.gz: 1e6ef1f6a11bb40a59efac744ce156b1ed9b187481406600b7367550ef42ae2176893c59d38d87b83bcc8c4750232cc02de873bf4af8e276093859b487d5e1de

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/README.md

@@ -1,6 +1,8 @@
 # AastraXmlApi
 
-TODO: Write a gem description
+This is a Gem of Carlton O'Riley's port of Aastra XML API Classes
+
+To view the original project: https://code.google.com/p/ruby-aastra/
 
 ## Installation
 
@@ -18,7 +20,9 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+    require 'aastra_xml_api'
+
+    AastraIPPhone.new ...
 
 ## Contributing
 
@@ -27,3 +31,7 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+# License
+
+GPL v2 - because the original project is GPL v2

data/aastra_xml_api.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["emery.miller@easyofficephone.com"]
   spec.description   = %q{Gemified version of Carlton O'Riley's Aastra XML Ruby Port}
   spec.summary       = %q{Aastra XML API for Ruby}
-  spec.homepage      = "http://www.easyofficephone.com"
+  spec.homepage      = "https://github.com/EasyOfficePhone/aastra_xml_api"
   spec.license       = "GNU GPL v2"
 
   spec.files         = `git ls-files`.split($/)

data/lib/aastra_xml_api.rb

@@ -1,6 +1,6 @@
 require 'cgi'
 
-(Dir['lib/aastra_xml_api/*'] - ['lib/aastra_xml_api/AastraIPPhoneGDImage.rb']).each do |path|
+(Dir['lib/aastra_xml_api/*'] - ['lib/aastra_xml_api/phone_gd_image.rb']).sort.each do |path|
   name = File.split(path)[1][0..-4]
   require "aastra_xml_api/#{name}"
 end

data/lib/aastra_xml_api/array_extensions.rb

@@ -0,0 +1,61 @@
+# 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
+#
+
+module AastraXmlApi
+  module ArrayExtension
+    # 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
+end

data/lib/aastra_xml_api/phone.rb

@@ -0,0 +1,205 @@
+###############################################################################
+# Aastra XML API Classes - Phone
+# Copyright Aastra Telecom 2008
+#
+# Ruby adaptation by Carlton O'Riley
+#
+# Phone 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)
+#
+###############################################################################
+
+module AastraXmlApi
+  class Phone
+    @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 Phone 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 Phone 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 += [PhoneSoftkeyEntry.new(index, escape(label), escape(uri), icon)]
+    end
+
+    # Add an icon to be used by either a softkey of PhoneTextMenu.
+    # Only available on the 55i, 57i, and 57iCT. The index is the same as
+    # what is referenced by addSoftkey or PhoneTextMenu.addEntry.
+    # The icon can be either a predefined icon or the hex of an icon image.
+    def addIcon(index, icon)
+      @icons += [PhoneIconEntry.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
+    # PhoneFormattedTextScreen.
+    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
+end

data/lib/aastra_xml_api/phone_configuration.rb

@@ -0,0 +1,56 @@
+################################################################################
+# Aastra XML API Classes - PhoneConfiguration
+# Copyright Aastra Telecom 8007
+#
+# Ruby adaptation by Carlton O'Riley
+#
+# PhoneConfiguration object.
+#
+# Public methods
+#
+# Inherited from Phone
+#     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 'PhoneConfiguration.rb'
+#     configuration = PhoneConfiguration.new
+#     configuration.addEntry('softkey1 label','Test')
+#     configuration.addEntry('softkey1 type','xml')
+#     configuration.setTriggerDestroyOnExit
+#     configuration.setBeep
+#     aastra_output configuration
+#
+################################################################################
+
+module AastraXmlApi
+  class PhoneConfiguration < Phone
+    # Adds a parameter and value entry to the list.
+    def addEntry(parameter, value)
+      @entries += [PhoneConfigurationEntry.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 = "<PhoneConfiguration"
+      out += " Beep=\"yes\"" if @beep == "yes"
+      out += " triggerDestroyOnExit=\"yes\"" if @triggerDestroyOnExit == "yes"
+      out += ">\n"
+      @entries.each do |entry|
+        out += entry.render
+      end
+      out += "</PhoneConfiguration>\n"
+      return out
+    end
+    end
+end

data/lib/aastra_xml_api/phone_configuration_entry.rb

@@ -0,0 +1,43 @@
+################################################################################
+# Aastra XML API Classes - PhoneConfigurationEntry
+# Firmware 2.0 or better
+# Copyright Aastra Telecom 2008
+#
+# Ruby adaptation by Carlton O'Riley
+#
+# Internal class for PhoneConfiguration object.
+################################################################################
+module AastraXmlApi
+  class PhoneConfigurationEntry < Phone
+    @parameter
+    @value
+
+    # Create a new parameter/value pair.  This overrides the
+    # initialize method in Phone.
+    def initialize(parameter, value)
+      @parameter = parameter
+      @value = value
+    end
+
+    # Set the parameter for this entry.
+    def setParameter(parameter)
+      @parameter = parameter
+    end
+
+    # Set the value for this entry.
+    def setValue(value)
+      @value = value
+    end
+
+    # Create XML text output for this entry.
+    def render
+      parameter = escape(@parameter)
+      value = escape(@value)
+      xml = "<ConfigurationItem>\n"
+      xml += "<Parameter>#{parameter}</Parameter>\n"
+      xml += "<Value>#{value}</Value>\n"
+      xml += "</ConfigurationItem>\n"
+      return xml
+    end
+  end
+end

data/lib/aastra_xml_api/phone_directory.rb

@@ -0,0 +1,122 @@
+################################################################################
+# Aastra XML API Classes - PhoneDirectory
+# Copyright Aastra Telecom 2008
+#
+# Ruby adaptation by Carlton O'Riley
+#
+# PhoneDirectory 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)
+#     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
+#     setNext(next) to set URI of the next page (optional)
+#     setPrevious(previous) to set URI of the previous page (optional)
+#     addEntry(name,phone) to add an element in the list to be displayed, at least one is needed.
+#     natsortbyname to order the list
+#
+# Example
+#     require 'PhoneDirectory.rb'
+#     directory = PhoneDirectory.new
+#     directory.setTitle('Title')
+#     directory.setNext('http://myserver.com/script.php?page=2')
+#     directory.setPrevious('http://myserver.com/script.php?page=0')
+#     directory.setDestroyOnExit
+#     directory.addEntry('John Doe', '200')
+#     directory.addEntry('Jane Doe', '201')
+#     directory.natsortByName
+#     directory.addSoftkey('1', 'Label', 'http://myserver.com/script.php?action=1')
+#     directory.addSoftkey('6', 'Exit', 'SoftKey:Exit')
+#     aastra_output directory
+#
+################################################################################
+
+module AastraXmlApi
+  class PhoneDirectory < Phone
+    @next
+    @previous
+
+    # Set the URI to load the next page of the directory.
+    def setNext(nextval)
+      @next = nextval
+    end
+
+    # Set the URI to load the previous page of the directory.
+    def setPrevious(previous)
+      @previous = previous
+    end
+
+    # Add directory entry with a name to be displayed and a telephone
+    # number to dial.
+    def addEntry(name, telephone)
+      @entries += [PhoneDirectoryEntry.new(name, telephone)]
+    end
+
+    # Sort array of names using natural sort order. i.e. Bob2 comes
+    # before Bob10.
+    def natsortByName
+      tmparray = []
+      tmp_array.include(ArrayExtension)
+      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
+      out = "<PhoneDirectory"
+      if not @previous.nil? then
+        previous = escape(@previous)
+        out += " previous=\"#{previous}\""
+      end
+      if not @next.nil? then
+        nextval = escape(@next)
+        out += " next=\"#{nextval}\""
+      end
+      out += " destroyOnExit=\"yes\"" if @destroyOnExit == "yes"
+      if not @cancelAction.nil? then
+        cancelAction = escape(@cancelAction)
+        out += " cancelAction=\"#{cancelAction}\""
+      end
+      out += " Beep=\"yes\"" if @beep == "yes"
+      out += " LockIn=\"yes\"" if @lockin == "yes"
+      out += " Timeout=\"#{@timeout}\"" if @timeout != 0
+      out += ">\n"
+      if not @title.nil? then
+        title = escape(title)
+        out += "<Title"
+        out += " wrap=\"yes\"" if @title_wrap == "yes"
+        out += ">#{title}</Title>\n"
+      end
+      index = 0
+      @entries.each do |entry|
+        out += entry.render if index < 30
+        index += 1
+      end
+      @softkeys.each do |softkey|
+        out += softkey.render
+      end
+      out += "</PhoneDirectory>\n"
+      return out
+    end
+  end
+end