aastra_xml_api 1.0.0

data/lib/aastra_xml_api/AastraIPPhoneConfiguration.rb

@@ -0,0 +1,55 @@
+################################################################################
+# 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

data/lib/aastra_xml_api/AastraIPPhoneConfigurationEntry.rb

@@ -0,0 +1,41 @@
+################################################################################
+# Aastra XML API Classes - AastraIPPhoneConfigurationEntry
+# Firmware 2.0 or better
+# Copyright Aastra Telecom 2008
+#
+# Ruby adaptation by Carlton O'Riley
+#
+# Internal class for AastraIPPhoneConfiguration object.
+################################################################################
+class AastraIPPhoneConfigurationEntry < AastraIPPhone
+  @parameter
+  @value
+
+  # Create a new parameter/value pair.  This overrides the
+  # initialize method in AastraIPPhone.
+  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

data/lib/aastra_xml_api/AastraIPPhoneDirectory.rb

@@ -0,0 +1,119 @@
+################################################################################
+# Aastra XML API Classes - AastraIPPhoneDirectory
+# Copyright Aastra Telecom 2008
+#
+# Ruby adaptation by Carlton O'Riley
+#
+# AastraIPPhoneDirectory 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)
+#     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 'AastraIPPhoneDirectory.rb'
+#     directory = AastraIPPhoneDirectory.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
+#
+################################################################################
+
+class AastraIPPhoneDirectory < AastraIPPhone
+  @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 += [AastraIPPhoneDirectoryEntry.new(name, telephone)]
+  end
+
+  # Sort array of names using natural sort order. i.e. Bob2 comes
+  # before Bob10.
+  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
+    out = "<AastraIPPhoneDirectory"
+    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 += "</AastraIPPhoneDirectory>\n"
+    return out
+  end
+end

data/lib/aastra_xml_api/AastraIPPhoneDirectoryEntry.rb

@@ -0,0 +1,32 @@
+########################################################################################################
+# Aastra XML API Classes - AastraIPPhoneDirectoryEntry
+# Copyright Aastra Telecom 2008
+#
+# Ruby adaptation by Carlton O'Riley
+#
+# Internal class for AastraIPPhoneDirectory object.
+########################################################################################################
+
+class AastraIPPhoneDirectoryEntry < AastraIPPhone
+  @name
+  @telephone
+
+  # Create new name and number entry.  Overrides the initialize method
+  # of AastraIPPhone.
+  def initialize(name, telephone)
+    @name = name
+    @telephone = telephone
+  end
+
+  # Get the name associated with this entry.
+  def getName
+    @name
+  end
+
+  # Create XML text output for this entry.
+  def render
+    name = escape(@name)
+    telephone = escape(@telephone)
+    return "<MenuItem>\n<Prompt>#{name}</Prompt>\n<URI>#{telephone}</URI>\n</MenuItem>\n"
+  end
+end

data/lib/aastra_xml_api/AastraIPPhoneExecute.rb

@@ -0,0 +1,58 @@
+################################################################################
+# Aastra XML API Classes - AastraIPPhoneExecute
+# Copyright Aastra Telecom 2008
+#
+# Ruby adaptation by Carlton O'Riley
+#
+# AastraIPPhoneExecute object.
+#
+# Public methods
+#
+# Inherited from AastraIPPhone
+#     setBeep to enable a notification beep with the object (optional)
+#
+# Specific to the object
+#     setTriggerDestroyOnExit to set the triggerDestroyOnExit tag to "yes" (optional)
+#     addEntry(url,interruptCall) to add an action to be executed.
+#
+# Example
+#     require 'AastraIPPhoneExecute.class.php'
+#     execute = AastraIPPhoneExecute.new
+#     execute.addEntry('http://myserver.com/script.php?choice=2')
+#     execute.addEntry('Command: Reset')
+#     aastra_output execute
+#
+################################################################################
+
+class AastraIPPhoneExecute < AastraIPPhone
+  @defaultIndex
+  @triggerDestroyOnExit
+
+  # Add a url (action to be performed).  If interruptCall is not nil, then
+  # then if a dial action is given, the current call will be put on hold.
+  # Default behavior is to not allow a current active call to be
+  # interrupted.
+  def addEntry(url, interruptCall=nil)
+    @entries += [AastraIPPhoneExecuteEntry.new(url, interruptCall)]
+  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
+    title = escape(@title)
+    out = "<AastraIPPhoneExecute"
+    out += " Beep=\"yes\"" if @beep == "yes"
+    out += " triggerDestroyOnExit=\"yes\"" if @triggerDestroyOnExit == "yes"
+    out += ">\n"
+    @entries.each do |entry|
+      out += entry.render
+    end
+    out += "</AastraIPPhoneExecute>\n"
+    return out
+  end
+  end

data/lib/aastra_xml_api/AastraIPPhoneExecuteEntry.rb

@@ -0,0 +1,30 @@
+################################################################################
+# Aastra XML API Classes - AastraIPPhoneExecuteEntry
+# Firmware 1.4.1 or better
+# Copyright Aastra Telecom 2008
+#
+# Ruby adaptation by Carlton O'Riley
+#
+# Internal class for AastraIPPhoneExecute object.
+################################################################################
+
+class AastraIPPhoneExecuteEntry < AastraIPPhone
+  @url
+  @interruptCall
+
+  # Create a new action to be performed.  if interruptCall is not nil then
+  # a currently active call can be interrupted by this action.
+  def initialize(url, interruptCall)
+    @url = url
+    @interruptCall = interruptCall
+  end
+
+  # Create XML text output for this entry.
+  def render
+    url = escape(@url)
+    xml = "<ExecuteItem URI=\"#{url}\""
+    xml += " interruptCall=\"no\"" if @interruptCall == "no"
+    xml += "/>\n"
+    return xml
+  end
+end

data/lib/aastra_xml_api/AastraIPPhoneFormattedTextScreen.rb

@@ -0,0 +1,117 @@
+################################################################################
+# Aastra XML API Classes - AastraIPFormattedPhoneTextScreen
+# Copyright Aastra Telecom 2008
+#
+# AastraIPPhoneFormattedTextScreen object.
+#
+# Public methods
+#
+# Inherited from AastraIPPhone
+#     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) 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
+#     addLine(text,size,align) to add a formatted line
+#     setScrollStart(height) to define the beginning of the scrolling section and its height
+#     setScrollEnd to define the end of the scrolling section
+#     setAllowDTMF to allow DTMF passthrough on the object
+#     setDoneAction(uri) to set the URI to be called when the user selects the default "Done" key (optional)
+#
+# Example
+#     require 'AastraIPPhoneFormattedTextScreen.rb'
+#     ftext = AastraIPPhoneFormattedTextScreen.new
+#     ftext.setDestroyOnExit
+#     ftext.addLine('Formatted Screen', 'double', 'center')
+#     ftext.setScrollStart('2')
+#     ftext.addLine('Scrolled text1')
+#     ftext.addLine('Scrolled text2')
+#     ftext.addLine('Scrolled text3')
+#     ftext.addLine('Scrolled text4')
+#     ftext.addLine('Scrolled text5')
+#     ftext.setScrollEnd
+#     ftext.addLine('Footer',NULL,'center')
+#     ftext.addSoftkey('1', 'Label', 'http://myserver.com/script.php?action=1','1')
+#     ftext.addSoftkey('6', 'Exit', 'SoftKey:Exit')
+#     ftext.addIcon('1', 'Icon:Envelope')
+#     aastra_output ftext
+#
+################################################################################
+
+class AastraIPPhoneFormattedTextScreen < AastraIPPhone
+  @doneAction
+  @allowDTMF
+
+  # Add a line of formatted text. size can only be 'normal' (default)
+  # or 'double'. align can be one of 'left' (default), 'center',
+  # or 'right'.
+  def addLine(text, size=nil, align=nil)
+    @entries += [AastraIPPhoneFormattedTextScreenEntry.new(text, size, align, 'normal')]
+  end
+
+  # Starts the beginning of a scrolling section on the display. If height
+  # is not given, then all available space is used to display the scrolling
+  # section. Otherwise, height cannot be bigger than 2.
+  def setScrollStart(height=nil)
+    @entries += [AastraIPPhoneFormattedTextScreenEntry.new(nil, height, nil, 'scrollstart')]
+  end
+
+  # Sets the end of a scrolling section on the display.
+  def setScrollEnd
+    @entries += [AastraIPPhoneFormattedTextScreenEntry.new(nil, nil, nil, 'scrollend')]
+  end
+
+  # Defines URI to call when the user selects the 'Done' softkey.
+  def setDoneAction(uri)
+    @doneAction = uri
+  end
+
+  # Allows keypad strokes to generate DTMF when a call is in progress
+  # while this object is displayed.
+  def setAllowDTMF
+    @allowDTMF = "yes"
+  end
+
+  # Create XML text output.
+  def render
+    out = "<AastraIPPhoneFormattedTextScreen"
+    out += " destroyOnExit=\"yes\"" if @destroyOnExit == "yes"
+    if not @cancelAction.nil? then
+      cancelAction = escape(@cancelAction)
+      out += " cancelAction=\"#{cancelAction}\""
+    end
+    if not @doneAction.nil? then
+      doneAction = escape(@doneAction)
+      out += " doneAction=\"#{doneAction}\""
+    end
+    out += " Beep=\"yes\"" if @beep == "yes"
+    out += " LockIn=\"yes\"" if @lockin == "yes"
+    out += " allowAnswer=\"yes\"" if @allowAnswer == "yes"
+    out += " Timeout=\"#{@timeout}\"" if @timeout != 0
+    out += " allowDTMF=\"#{yes}\"" if @allowDTMF == "yes"
+    out += ">\n"
+    @entries.each do |entry|
+      out += entry.render
+    end
+    @softkeys.each do |softkey|
+      out += softkey.render
+    end
+    iconList = 0
+    @icons.each do |icon|
+      if iconList == 0 then
+        out += "<IconList>\n"
+        iconList = 1
+      end
+      out += icon.render
+    end
+    out += "</IconList>\n" if iconList != 0
+    out += "</AastraIPPhoneFormattedTextScreen>\n"
+    return out
+  end
+  end

data/lib/aastra_xml_api/AastraIPPhoneFormattedTextScreenEntry.rb

@@ -0,0 +1,48 @@
+################################################################################
+# Aastra XML API Classes - AastraIPPhoneFormattedTextScreenEntry
+# Firmware 2.0 or better
+# Copyright Aastra Telecom 2008
+#
+# Ruby adaptation by Carlton O'Riley
+#
+# Internal class for AastraIPPhoneFormattedTextScreen object.
+################################################################################
+
+class AastraIPPhoneFormattedTextScreenEntry < AastraIPPhone
+  @text
+  @size
+  @align
+  @type
+
+  # Creates new formatted text entry.  size is one of 'normal' (default)
+  # or 'double'. align is one of 'left' (default), 'center', or 'right'.
+  # type must be one of 'normal', 'scrollstart', or 'scrollend'.
+  def initialize(text, size, align, type)
+    if size == 'double' then
+      @text = convert_high_ascii(text)
+    else
+      @text = text
+    end
+    @size = size
+    @align = align
+    @type = type
+  end
+
+  # Create XML text output for this entry.
+  def render
+    case @type
+    when "normal"
+      xml = "<Line"
+      xml += " Size=\"#{@size}\"" if not @size.nil?
+      xml += " Align=\"#{@align}\"" if not @align.nil?
+      xml += ">"
+      xml += "#{escape(@text)}</Line>\n"
+    when "scrollstart"
+      xml = "<Scroll"
+      xml += " Height=\"#{@size}\"" if not @size.nil?
+      xml += ">\n"
+    when "scrollend" then xml = "</Scroll>\n"
+    end
+    return xml
+  end
+end

data/lib/aastra_xml_api/AastraIPPhoneGDImage.rb

@@ -0,0 +1,185 @@
+require 'GD'
+
+################################################################################
+# Aastra XML API Classes - Aastra XML API Classes - AastraIPPhoneGDImage
+# Copyright Aastra Telecom 2008
+#
+# Ruby adaptation by Carlton O'Riley
+#
+# Firmware 2.2.0 or better
+#
+# AastraIPPhoneGDImage for AastraIPPhoneImageScreen and AastraIPPhoneImageScreen.
+#
+# ruby needs ruby-gd gem installed
+# ------------------------------
+#
+# Public methods
+#
+#	drawttftext(fontsize,angle,x,y,text,colorIndex,fontfile)
+#	Writes text to the image using TrueType fonts
+#	fontsize	The font size. Depending on your version of GD, this should be specified as the pixel
+#			size (GD1) or point size (GD2)
+#	angle		The angle in degrees, with 0 degrees being left-to-right reading text. Higher values
+#			represent a counter-clockwise rotation. For example, a value of 90 would result in
+#			bottom-to-top reading text.
+#	x,y		The coordinates given by x and y will define the basepoint of the first character
+#			(roughly the lower-left corner of the character).
+#	colorIndex	0=White	1=Black
+#	fontfile	Location and name of the ttf file to use
+#
+#	drawtext(fontsize,x,y,text,colorIndex)
+#	Writes text to the image using built-in font
+#	fontsize	The font size. From 1 to 5
+#	x,y		The coordinates given by x and y will define the basepoint of the first character
+#			(roughly the lower-left corner of the character).
+#	colorIndex	0=White	1=Black
+#
+#	rectangle(x1,y1,x2,y2,colorIndex,filled)
+#	Creates a rectangle starting at the specified coordinates.
+#	x1,y1		Upper left x,y coordinate. 0,0 is the top left corner of the image.
+#	x2,y2		Bottom right x,y coordinate
+#	colorIndex	0=White	1=Black
+#	filled		Boolean, optional (default if False)
+#
+#	ellipse(cx,cy,width,height,colorIndex,filled)
+#	Draws an ellipse centered at the specified coordinates.
+#	cx,cy		x-coordinate and y-coordinate of the center
+#	width		the ellipse width
+#	height		the ellipse height
+#	colorIndex	0=White	1=Black
+#	filled		Boolean, optional (default if False)
+#
+#	line(x1,y1,x2,y2,colorIndex)
+#	Draws a line
+#	x1,y1		x,y coordinates for the first point
+#	x2,y2		x,y coordinates for the second point
+#	colorIndex	0=White	1=Black
+#
+#	setGDImage(image)
+#	Imports an externally generated GD image
+#	image		GD image to import
+#
+#	getGDImage()
+#	Exports the current GD image
+#
+#	setFontPath(fontpath)
+#	Set directory path for the fonts to use
+#	fontpath	Directory for the ttf fonts
+#	Default value
+#		Windows based platform		C:\Windows\Fonts
+#		Linux based platform			../fonts
+#   Mac OS X based platform   ../fonts
+#   Rails based platform      RAILS_ROOT/fonts
+#
+# Example 1
+#	require 'AastraIPPhoneGDImage.rb'
+#	phoneImageGD = AastraIPPhoneGDImage.new
+#	time = Time.now.strftime("%H:%M")
+#	phoneImageGD.drawttftext(30, 0, 10, 39, time, 1,'Ni7seg.ttf')
+#
+# Example 2
+#	require 'AastraIPPhoneGDImage.rb'
+#	phoneImageGD = AastraIPPhoneGDImage.new
+#	utf8text = "东丝丞丟丸"
+#	phoneImageGD.drawttftext(20, 0, 5, 35, utf8text, 1, 'arialuni.ttf')
+#
+################################################################################
+
+class AastraIPPhoneGDImage
+  @img
+  @white
+  @black
+  @blackNoAntiAliasing
+  @font
+  @fontpath
+
+  # Creates a new GD image of size 144x40 (maximum allowed on phone). Also
+  # creates black and white colors to be used and sets default font path
+  # based on whether this is running under rails or a specific
+  # operating system.
+  def initialize
+    # create image
+    @img = GD::Image.new(144, 40)
+
+    # define black and white
+    @white = @img.colorAllocate(255, 255, 255)
+    @black = @img.colorAllocate(0, 0, 0)
+
+    # black and white only so disable anti-aliasing
+    @black *= -1
+    @white *= -1
+
+    # define a default font path
+    if defined?(RAILS_ROOT) then
+      @fontpath = "#{RAILS_ROOT}/fonts"
+    else
+      os = RUBY_PLATFORM.downcase
+      @fontpath = "C:\\Windows\\Fonts" if not os.scan(/win/).nil?
+      @fontpath = "../fonts" if not os.scan(/linux$/).nil?
+      @fontpath = "../fonts" if not os.scan(/darwin\d+\.\d+$/).nil?
+    end
+    ENV['GDFONTPATH'] = @fontpath
+  end
+
+  # Set font path for GD.
+  def setFontPath(fontpath)
+    @fontpath = fontpath
+    ENV['GDFONTPATH'] = @fontpath
+  end
+
+  # Draw text on the image using a specific true type font.
+  # See GD documentation for parameters.
+  def drawttftext(size, angle, x, y, text, colorIndex, font)
+    @img.stringTTF(getColor(colorIndex), font, size, angle, x, y, text)
+  end
+
+  # Draw text on the image.
+  def drawtext(size, x, y, text, colorIndex)
+    @img.string(size, x, y, text, getColor(colorIndex))
+  end
+
+  # Set the image from an externally created GD image.
+  def setGDImage(image)
+    @img = image
+  end
+
+  # Get the GD image created.
+  def getGDImage
+    return @img
+  end
+
+  # Draw a rectangle on the image. Rectangle will be unfilled by default.
+  def rectangle(x1, y1, x2, y2, colorIndex, filled=false)
+    if filled then
+      @img.filledRectangle(x1, y1, x2, y2, getColor(colorIndex))
+    else
+      @img.rectangle(x1, y1, x2, y2, getColor(colorIndex))
+    end
+  end
+
+  # Draw an ellipse on the image. Ellipse will be unfilled by default.
+  def ellipse(cx, cy, width, height, colorIndex, filled=false)
+    if filled then
+      @img.filledEllipse(cx, cy, width, height, 0, 360, getColor(colorIndex))
+    else
+      @img.ellipse(cx, cy, width, height, 0, 360, getColor(colorIndex))
+    end
+  end
+
+  # Draw a line on the image.  Line will be solid by default.
+  def line(x1, y1, x2, y2, colorIndex, dashed=false)
+    if dashed then
+      @img.dashedLine(x1, y2, x2, y2, getColor(colorIndex))
+    else
+      @img.line(x1, y2, x2, y2, getColor(colorIndex))
+    end
+  end
+
+  # Get the GD color element based on an index.
+  # 0:: white
+  # 1:: black
+  def getColor(index)
+    return @white if index == 0
+    return @black
+  end
+end