Export Vonage Call Log using IronPython and WatiN

Here is another IronPython script that shows how to use the WatiN testing framework, which is great for testing web pages in Internet Explorer, and it is starting to support Google Chrome and Firefox too. We use WatiN at work for testing the full stack on an ASP.Net website, and it works very well even for AJAX sites. This example will login to Vonage and export all of a user's call data to a CSV format.
"""Sample for getting Watin to work with IronPython Usage: Download the WatiN-2.0.10.928-net-2.0.zip file from http://sourceforge.net/projects/watin/files/ put this script file(WatinExample.py), Interop.SHDocVw.dll, Microsoft.mshtml.dll, and WatiN.Core.dll into a folder called Watin import the script or run execfile( "c:\\PATHTOFILES\\WatinExample.py") from console use the Run() method to run the script, or use Reload() to reload the module after making changes.""" import sys import clr import re from System.Reflection import Assembly #clr.AddReference("d:\My Documents\Resolver\Watin\WatiN.Core.dll") #Only works for IronPython 1.1 sys.path.append("D:\My Documents\Resolver\Watin") #Needed so that WatiN can find the Interop.SHDocVw.dll file assembly = Assembly.LoadFile("d:\\My Documents\\Resolver\\Watin\\WatiN.Core.dll") #Better way to import the file clr.AddReference(assembly) from WatiN.Core import * from System import DateTime,TimeSpan def reload(): """Code used to reload this module. Helpful for when testing from console.""" print "Reloading..." global Vonage Vonage.Close() execfile( "D:\\My Documents\\Resolver\\Watin\\WatinExample.py") def run(): """Code used to run a test script. Helpful for when testing from console.""" global listActivity Vonage.Logon("username","password") listActivity = Vonage.ParseActivity("1-(801)-123-4567", DateTime(2008,2,1),DateTime(2008,5,31)) Vonage.ArrayToCSV("C:\\test.csv",listActivity) class Vonage(object): "Static class for working with Vonage website using WatiN" IE = None #Instance of IE object used by WatiN @staticmethod def Logon(strUsername, strPassword): """Initiates WatiN for use in IronPython to scrape the Vonage website for call activity.""" print "Vonage.Login: Loading IE and browsing to Vonage.com" #TODO: Setup logging with different levels. Attach to WatiN for click events Vonage.IE = IE("http://www.vonage.com") Settings.WaitUntilExistsTimeOut = 25 #For development work set the timeout value to 15 seconds instead of default 30 seconds. print "Vonage.Login: Login to Vonage.com" Vonage.IE.TextField(Find.ByName("username")).TypeText(strUsername) Vonage.IE.TextField(Find.ByName("password")).TypeText(strPassword) Vonage.IE.Form(Find.ById("logonForm")).Submit() Vonage.IE.Link(Find.ByText("Log Out")).WaitUntilExists(15) #Waits up to 15 seconds for IE to login. If fails an exception will be thrown @staticmethod def isAuthenticated(): """Returns True if the session is currently logged in or false otherwise.""" return Vonage.IE.Link(Find.ByText("Log Out")).Exists @staticmethod def ParseActivity(strPhoneNumber, dtStartDate, dtEndDate): """Browses to the Activity section and parses the results. strPhoneNumber: Line Number to parse. Must be in 1-(xxx)-xxx-xxxx format. Must append (Fax) or (Virtual) for special lines. dtStartDate: Start Date (Inclusive). dtEndDate: End Date (Inclusive). Returns a list of call details""" if not Vonage.isAuthenticated(): raise "Vonage.ParseActivity Error: User is not authenticated." Vonage.IE.Link(Find.ByText("Activity")).Click() lstActivityData = [["DateTime", "From", "To", "Duration", "TransactionID","FromCallerID","TransferedTo"]] #Store Activity data as list of row data. First element is header row. #Run report for Incoming calls Vonage.IE.Link(Find.ByText("Advanced Activity Search")).Click() Vonage.IE.SelectList(Find.ByName("didID")).Option(strPhoneNumber).Select() #Select the phone number requested. If phone number does not exist an exception will be thrown. Vonage.SetDate("start",dtStartDate) Vonage.SetDate("end",dtEndDate.AddDays(1)) #NOTE: Have to set end date + one day to be inclusive Vonage.IE.RadioButton(Find.ByValue("Incoming")).Click() #First select incoming and run the report Vonage.IE.Form(Find.ByName("activityForm")).Submit() while True: Vonage.ParsePageData(lstActivityData) if Vonage.IE.Link(Find.ByText("Next>>")).Exists: Vonage.IE.Link(Find.ByText("Next>>")).Click() else: break #Run report again for outgoing calls Vonage.SetDate("start",dtStartDate) Vonage.SetDate("end",dtEndDate) Vonage.IE.RadioButton(Find.ByValue("Outgoing")).Click() #First select incoming and run the report Vonage.IE.Form(Find.ByName("activityForm")).Submit() while True: Vonage.ParsePageData(lstActivityData) if Vonage.IE.Link(Find.ByText("Next>>")).Exists: Vonage.IE.Link(Find.ByText("Next>>")).Click() else: break lstActivityData.sort(Vonage.SortData) #Sort data to merge Incoming and Outgoing calls return lstActivityData @staticmethod def ParsePageData(lstData): """Parses the call data from a page and appends each row to lstData""" print "Vonage.ParsePageData: Parse Page data." #TODO parse total results out of string and display "xx of xx" using table row count re.DOTALL = True #Make the . character match newlines in re.search for aRow in Vonage.IE.Table("received_calls").TableRows: #print aRow.InnerHtml if aRow.Index > 1 and aRow.TableCells.Count == 6: #Skip first and second row (header row) and any other row with less than 6 cells lstRowData = [] #See Row Data Format above lstData.append(lstRowData) #Add row to list lstRowData.append(DateTime.Parse(aRow.TableCells[0].Text + aRow.TableCells[1].Text)) #Create DateTime lstRowData.append(aRow.TableCells[2].Text.Trim()) #add From lstRowData.append(aRow.TableCells[3].Text.Trim()) #add To TODO: Parse Transfer data lstRowData.append(TimeSpan.Parse(aRow.TableCells[4].Text)) #add Duration lstRowData.append(long(aRow.TableCells[5].Text.Trim())) #add TransactionID regEx = re.search("<b>([^/]+)</b>'",aRow.TableCells[2].InnerHtml) #Get caller ID info if regEx and len(regEx.groups()) == 1: lstRowData.append(regEx.group(1)) else: lstRowData.append(None) regEx = re.search("Forwarded to (\d+)'",aRow.TableCells[2].InnerHtml) #Get forward info if regEx and len(regEx.groups()) == 1: lstRowData.append(regEx.group(1)) else: lstRowData.append(None) @staticmethod def SortData(lstA, lstB): "Comparer used to sort array data. Rates string datatypes highest, then compares based on datetime" if type(lstA[0]) == str: return -1 elif type(lstB[0]) == str: return 1 else: return cmp(lstA[0],lstB[0]) @staticmethod def SetDate(strPrefix, dtDate): """Used to set the Start and End Dates strPrefix: start or end dtDate: Datetime (inclusive)""" Vonage.IE.SelectList(Find.ByName(strPrefix+"Month")).Option(dtDate.ToString("MMM")).Select() Vonage.IE.SelectList(Find.ByName(strPrefix+"Day")).Option(dtDate.ToString("dd")).Select() Vonage.IE.SelectList(Find.ByName(strPrefix+"Year")).Option(dtDate.ToString("yyyy")).Select() Vonage.IE.SelectList(Find.ByName(strPrefix+"Time")).Option("Midnight").Select() @staticmethod def Close(): """Closes IE instance and cleans up""" if Vonage.IE <> None: print "Closing IE..." Vonage.IE.Close() Vonage.IE = None @staticmethod def ArrayToCSV(filename, listData): """Code used to convert an array of row data into a CSV file.""" csvFile = open(filename, "w") for aRow in listData: bFirst = True for aValue in aRow: if bFirst: bFirst = False #Reset first flag else: csvFile.write(",") #seperate values with a comma #Write data item with special conversions if type(aValue) in (int, long, float): #Keep integer types the same. Also DateTime is a special case (See ExcelManager.SetCell) csvFile.write(str(aValue)) #write numbers without quotes elif type(aValue) is TimeSpan: csvFile.write(str(aValue.TotalMinutes)) #write value as total minutes elif aValue is None: pass #write null entry as nothing (ie: 1,2,,4) else: #Cast everything else to a string csvFile.write("\""+str(aValue)+"\"") #Convert everything else to a string and enclose in brackets csvFile.write("\n") #New line after each row. Note: \r\n doesnt work correctly on IPY 1.1 csvFile.close()
Enjoy!