ipp_quickbase_devkit 0.0.1

data/examples/cookbookfiles/addChangeRemoveUserRole.rb

@@ -0,0 +1,21 @@
+
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new("username","password")
+
+# get Fred's QuickBase user info
+qbc.getUserInfo("fred_flintstone@internet.com")
+
+fredsUserID = qbc.userid.dup
+
+# Assume "10" is the id of the Viewer role in the application with the "bbqm84dzy" id
+qbc.addUserToRole( "bbqm84dzy", fredsUserID, "10" )
+
+# Assume "11" is the id of the Participant role in the application with the "bbqm84dzy" id
+qbc.changeUserRole( "bbqm84dzy", fredsUserID, "10", "11" )
+
+# Remove Fred from the Participant Role
+qbc.removeUserFromRole( "bbqm84dzy", fredsUserID, "11" )
+
+
+

data/examples/cookbookfiles/addOrEditRecord.rb

@@ -0,0 +1,10 @@
+
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new("username","password")
+
+# Attempt to change Name to Fred in record 7
+# If there is no record 7, add a new record and set the Name to Fred.
+qbc.addFieldValuePair("Name",nil,nil,"Fred")
+qbc.addOrEditRecord("dbiddbid",qbc.fvlist,"7")
+

data/examples/cookbookfiles/application_object.rb

@@ -0,0 +1,55 @@
+require 'QuickBaseObjects'
+
+qbob = QuickBase::Objects::Builder.new("username","password")
+  
+myApplication = qbob.application("My Application")
+  
+puts "\n\nApplication name:\n"
+puts myApplication.name
+
+puts "\n\nApplication roles:\n"
+myApplication.roles.each_value{|role|puts "name: #{role.name}, id: #{role.id}, access: #{role.access}"}
+
+puts "\n\nApplication users:\n"
+myApplication.users.each_value{|user|puts "id: #{user.id}"}
+
+puts "\n\nApplication variables:\n"
+myApplication.variables.each_value{|variable|puts "#{variable.name}: #{variable.value}"}
+
+puts "\n\nValue of application variable 'TestVariable':\n"
+puts myApplication.vTestVariable
+
+puts "\n\nSet the value of application variable 'TestVariable':\n"
+myApplication.vTestVariable="New value for test variable"
+
+puts "\n\nApplication pages:\n"
+myApplication.pages.each_value{|page|puts page.name}
+
+puts "\n\nDefault application page:\n"
+puts myApplication.pDefault_Dashboard.name
+  
+puts "\n\nTables from My Application:\n"
+myApplication.tables.each_value{|table|puts table.name}
+  
+puts "\n\nQueries from the Contacts table:\n"
+myApplication.tContacts.queries.each_value{|query|puts query.name}
+
+puts "\n\nProperties of the List All query from the Contacts table:\n"
+myApplication.tContacts.qList_All.properties.each_pair{|key,value|puts "#{key}: #{value}" }
+
+puts "\n\nNames from the List All query from the Contacts table:\n"
+records = myApplication.tContacts.qList_All.run 
+records.each{|record| puts record.fName}
+
+puts "\n\nColumns of the List All query from the Contacts table:\n"
+puts myApplication.tContacts.qList_All.qyclst
+  
+puts "\n\nFields from the Contacts table:\n"
+myApplication.tContacts.fields.each_value{|field|puts field.name}
+  
+puts "\n\nField ID of the Phone field in the Contacts table:\n"
+puts myApplication.tContacts.fPhone.id
+
+puts "\n\nName of field 7 from the Contacts table:\n"
+puts myApplication.tContacts.fields["7"].name
+

data/examples/cookbookfiles/applyRubyFormulas.rb

@@ -0,0 +1,10 @@
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new(ENV["quickbase_username"],ENV["quickbase_password"])
+qbc.iterateRecords("bdcvpsxpy",qbc.getFieldNames("bdcvpsxpy")){|record|
+  nameAndNumber = eval(record['ruby formula 1']) || "<name and number>"
+  qbc.clearFieldValuePairList
+  qbc.addFieldValuePair("name+number",nil,nil,nameAndNumber)
+  qbc.editRecord("bdcvpsxpy", record['Record ID#'],qbc.fvlist)
+}
+

data/examples/cookbookfiles/average.rb

@@ -0,0 +1,27 @@
+
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new("username","password")
+
+qbc.iterateRecords("bcct3jb3b",["number"]){|record|
+   puts "number: #{record['number']}" 
+}
+
+average = qbc.average("bcct3jb3b",["number"])
+puts "average: #{average['number']}"
+
+=begin
+
+number: 62
+number: 21
+number: 76
+number: 13
+number: 34
+number: 2
+number: 66
+number: 2
+number: 3
+average: 31.0
+
+
+=end

data/examples/cookbookfiles/backupApplication.rb

@@ -0,0 +1,8 @@
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new( "my_username", "my_password", "my_application" )
+
+# "true" at the end means copy all the data, not just the structure of the database
+qbc.cloneDatabase( qbc.dbid, "my_application_backup", "backup of my_application", true )
+
+qbc.signOut

data/examples/cookbookfiles/cacheSchemas.rb

@@ -0,0 +1,53 @@
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new
+
+# get the schema for the QuickBase Community Forum
+firstTime=true
+2.times {
+
+  totalTime = Time.now
+  
+  8.times {
+    getSchemaTime = Time.now
+    qbc.getSchema("bbqm84dzy")
+    puts "getSchema took #{Time.now-getSchemaTime} seconds"
+  }
+  
+  puts "\nTotal time: #{Time.now-totalTime} seconds"
+  
+  qbc.signOut
+  qbc = QuickBase::Client.new
+  qbc.cacheSchemas = true
+  puts "Caching schema..." if firstTime
+  firstTime = false
+}
+
+=begin
+
+Sample output of the above script:-
+
+getSchema took 1.438 seconds
+getSchema took 0.515 seconds
+getSchema took 0.5 seconds
+getSchema took 0.485 seconds
+getSchema took 0.515 seconds
+getSchema took 0.532 seconds
+getSchema took 0.484 seconds
+getSchema took 0.5 seconds
+
+Total time: 4.969 seconds
+Caching schema...
+getSchema took 0.515 seconds
+getSchema took 0.016 seconds
+getSchema took 0.015 seconds
+getSchema took 0.0 seconds
+getSchema took 0.016 seconds
+getSchema took 0.0 seconds
+getSchema took 0.016 seconds
+getSchema took 0.031 seconds
+
+Total time: 0.609 seconds
+
+=end
+

data/examples/cookbookfiles/calculateRunningTotals.rb

@@ -0,0 +1,11 @@
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new(ENV["quickbase_username"],ENV["quickbase_password"])
+
+runningTotal = 0
+qbc.iterateRecords("bdcvpsxpy",qbc.getFieldNames("bdcvpsxpy"),nil,nil,"List All by Date Created"){|record|
+  runningTotal += record['number'].to_i
+  qbc.clearFieldValuePairList
+  qbc.addFieldValuePair("running total",nil,nil,runningTotal.to_s)
+  qbc.editRecord("bdcvpsxpy",record['Record ID#'],qbc.fvlist)
+}

data/examples/cookbookfiles/copyrecords.rb

@@ -0,0 +1,73 @@
+require 'QuickBaseClient'
+require 'Date'
+
+if ARGV.length < 4
+   puts "\n Usage: ruby copyrecords.rb <username> <password> <sourceTableDBID> <targetTableDBID>\n"
+   puts "\n e.g. ruby copyrecords.rb myusername mypassword xxxxxxxxx yyyyyyyyy\n."
+   puts "\n Adds copies of records from a main table to a history table."
+   puts "\n This script assumes the field names match between the two tables.\n"
+   exit
+end
+
+qbc = QuickBase::Client.new( ARGV[0], ARGV[1] )
+
+#Uncomment the following line to see the data being sent to QuickBase and returned from QuickBase
+#qbc.printRequestsAndResponses = true 
+
+#fieldNames is the list of fields values you want to copy
+#Change the list to match your real field names.
+
+fieldNames = Array.new
+fieldNames = [ "Record ID#", "Date Updated", "Title", "Description", "MutipleChoiceField" ]
+
+puts "Adding copies of all source table records to target table"
+
+#fieldValues is a hash of arrays of field values from all records in the source table
+qbc.getSchema( ARGV[2] )
+fieldValues = qbc.getAllValuesForFields( ARGV[2], fieldNames )
+numRecs = fieldValues[ "Record ID#" ].length
+
+#for each record (i) retrieved from the source table...
+(0..numRecs.to_i-1).each{ |i|
+   
+   #clear previously uploaded field values
+   qbc.clearFieldValuePairList
+   
+   #loop through the list of field values for record i
+   fieldValues.each { |fieldName,valueArray|
+   
+       # get the value of fieldName in record i
+       value = valueArray[i]
+       
+       # copy the field name - it will need to be changed for some fields
+       targetFieldName = fieldName.dup
+       
+       # date fields must be converted from the numeric version to a format that can be sent back to QuickBase
+       value = qbc.formatDate( value, nil, true ) if targetFieldName == "Date Updated"
+       
+       # put the source table's Record ID# in a different field in the target table
+       # (you could do this for any field that has a different name in the target table)
+       targetFieldName = "Source Record ID #" if targetFieldName == "Record ID#"
+       
+       # the values of multiple choice fields must be in the list of available choices
+       if targetFieldName == "MutipleChoiceField"  
+          qbc._fieldNameAddChoices( targetFieldName, value ) 
+       end
+       
+       # add the field value to the list of fields to be uploaded to the target table
+       qbc.addFieldValuePair( targetFieldName, nil, nil,  value ) 
+   }
+   
+   puts "Adding record #{i} of #{numRecs.to_i-1}"
+   qbc.addRecord( ARGV[3], qbc.fvlist )
+   
+   # print any error message from QuickBase, if there was one
+   if !qbc.requestSucceeded
+     qbc.printLastError
+   end
+   
+}
+
+# signout of QuickBase
+qbc.signOut
+

data/examples/cookbookfiles/count.rb

@@ -0,0 +1,26 @@
+
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new("username","password")
+
+qbc.iterateRecords("bcct3jb3b",["number"]){|record|
+   puts "number: #{record['number']}" 
+}
+
+count = qbc.count("bcct3jb3b",["number"])
+puts "count: #{count['number']}" 
+
+=begin
+
+number: 62
+number: 21
+number: 76
+number: 13
+number: 34
+number: 2
+number: 66
+number: 2
+number: 3
+count: 9
+
+=end

data/examples/cookbookfiles/createRecordNavigatorHTML.rb

@@ -0,0 +1,42 @@
+
+require 'QuickBaseClient'
+require 'QuickBaseMisc'
+
+qbc = QuickBase::Client.new
+
+i = 0
+recordViewLinks = ""
+qbc.iterateRecords("8emtadvk",["Message ID#","Subject"]){|msg|
+  if i < 15
+    r = QuickBase::Misc.decimalToBase32(msg['Message ID#'])
+    recordViewLinks << "<a href=\"https://www.quickbase.com/db/8emtadvk?a=dr&r=#{r}\" target=\"RecordContainer\">#{msg['Subject']}</a><br>"
+  end
+  i += 1
+}
+
+html = <<EndHTML
+
+<html>
+<head>
+<style type="text/css">
+td { white-space: nowrap; vertical-align: top }
+</style>
+</head>
+<body>
+<table border="1" >
+<tr><td><b>Community Forum Records</b><td><td></tr>
+<tr>
+<td>
+#{recordViewLinks}
+</td>
+<td>
+<iframe name="RecordContainer" Width="800" Height="650" />
+</td>
+</tr>
+</table>
+</body>
+</html>
+
+EndHTML
+
+File.open("QuickBaseCommunityForumRecordViewer.html","w"){|f|f.write(html)}

data/examples/cookbookfiles/createReportDashboard.rb

@@ -0,0 +1,35 @@
+
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new
+
+reportsHTML = ""
+reportNames = qbc.getReportNames("8emtadvk")
+reportNames.each{|reportName|
+  report = qbc.lookupQueryByName(reportName) 
+  reportID = report.attributes["id"]
+  reportsHTML << "<a href=\"https://www.quickbase.com/db/8emtadvk?a=q&qid=#{reportID}\" target=\"ReportContainer\" >#{reportName}</a><BR>"
+}
+
+html =   "<html>"
+html << "<head>"
+html << "<style type=\"text/css\">"
+html << "td { white-space: nowrap; vertical-align: top }"
+html << "</style>"
+html << "</head>"
+html << "<body>"
+html << "<table border=\"1\" >"
+html << "<tr><td><b>Community Forum Reports</b><td><td></tr>"
+html << "<tr>"
+html << "<td><b>"
+html << reportsHTML
+html << "</b></td>"
+html << "<td>"
+html << "<iframe name=\"ReportContainer\" Width=\"700\" Height=\"800\" />"
+html << "</td>"
+html << "</tr>"
+html << "</table>"
+html << "</body>"
+html << "</html>"
+
+File.open("QuickBaseCommunityForumReports.html","w"){|f|f.write(html)}

data/examples/cookbookfiles/createTable.rb

@@ -0,0 +1,12 @@
+
+require 'QuickBaseClient'
+
+# Add an Authors table to a Books application
+
+qbc = QuickBase::Client.new( "username","password","Books")
+
+qbc.createTable("Authors")
+
+qbc._addField("Name", "text")
+
+

data/examples/cookbookfiles/deviation.rb

@@ -0,0 +1,25 @@
+
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new("username","password")
+
+qbc.applyDeviationToRecords("bcc9qcnxw","number","deviation")
+
+numberAverage = qbc.average("bcc9qcnxw",["number"])
+puts "number average: #{numberAverage['number']}"
+
+qbc.iterateRecords("bcc9qcnxw",["number","deviation"]){|record|
+   puts "number: #{record['number']}, deviation: #{record['deviation']}"
+}
+
+=begin
+
+Sample output of above script:-
+
+number average: 31.0
+number: 20, deviation: 11
+number: 36, deviation: 5
+number: 56, deviation: 25
+number: 12, deviation: 19
+
+=end

data/examples/cookbookfiles/downloadCookbook.rb

@@ -0,0 +1,97 @@
+require 'QuickBaseClient'
+require 'cgi'
+
+if ARGV.length < 2
+   puts "\n Usage: ruby downloadCookbook.rb <username> <password>\n"
+   puts "\n This script copies the recipes from the QuickBase API Cookbook to your local drive.\n"
+   exit
+end
+
+qbc = QuickBase::Client.new( ARGV[0], ARGV[1] )
+
+fieldsToDownload = [ "Record ID#", "Title", "Keywords", "Problem", "Solution", "Discussion", "See Also", "File Attachment", "Ingredient 1",  "Ingredient 2", "Ingredient 3", "Chef" ]
+
+# this is the original QuickBase API Cookbook v3 recipes table
+fieldValues = qbc.getAllValuesForFields( "bcdcajmrg", fieldsToDownload, nil, nil, "List All" )
+
+numRecs = fieldValues[ "Record ID#" ].length
+
+cwd=Dir.getwd 
+fileprefix = "#{cwd}/cookbookfiles/"
+Dir.mkdir( fileprefix ) if !File.exists?( fileprefix )
+Dir.chdir( fileprefix ) 
+
+File.open( "QuickBaseAPICookbook.html", "w" ) { |outputFile |
+
+outputFile.write( "<HTML><HEAD><TITLE>QuickBase API Cookbook v3</TITLE></HEAD><BODY><H1><a href=\"https://www.quickbase.com/db/bcdcajmrg\">QuickBase API Cookbook v3</a></H1>" )
+
+(0..numRecs.to_i-1).each{ |i|
+
+   link = ""
+   title = ""
+   keywords = ""
+   problem = ""
+   solution = ""
+   discussion =""
+   seeAlso = ""
+   file = ""
+   ingredient1 = ""
+   ingredient2 = ""
+   ingredient3 = ""
+   chef = ""
+   recordID = ""
+   
+   fieldValues.each { |fieldName,valueArray|
+   
+       # get the value of fieldName in record i
+       value = valueArray[i]
+       
+       value.gsub!("<BR/>","\n")
+       
+       case fieldName
+          when "Record ID#" 
+	     link = "https://www.quickbase.com/db/bcdcajmrg?a=dr&rid=#{value}"
+	     recordID = value.dup
+	  when "Title" then title = "#{CGI.escapeHTML(value)}"
+	  when "Keywords" then keywords = "<h3>Keywords</h3>#{CGI.escapeHTML(value)}<br>"
+	  when "Problem" then problem = "<h3>Problem:</h3>#{CGI.escapeHTML(value)}<br>"
+	  when "Solution" then solution = "<h3>Solution:</h3><pre>#{CGI.escapeHTML(value)}</pre><br>"
+	  when "Discussion" then discussion = "<h3>Discussion:</h3>#{CGI.escapeHTML(value)}<br>"
+	  when "See Also" then seeAlso = "<h3>See Also:</h3>#{CGI.escapeHTML(value)}<br>"
+	  when "File Attachment" 
+	     if value.length > 0
+	        fileToWrite = "#{fileprefix}#{value}"
+	        #file = "<h3>File Attachment:</h3><a href=\"file:///#{fileprefix}#{value}\">#{fileprefix}#{value}</a><br>" 
+	        file = "<h3>File Attachment:</h3><a href=\"#{value}\">#{value}</a><br>" 
+	        qbc.downLoadFile(qbc.dbid, recordID, "12" )
+           fileContents = qbc.fileContents.dup
+            if fileContents.length > 0
+               fileContents.gsub!( "\r\n", "\n" )
+               File.open( fileToWrite, "w" ){|f|f.write(fileContents) }
+            end
+	     end 
+	  when "Ingredient 1" then ingredient1 = "<h3>Ingredients:</h3>#{CGI.escapeHTML(value)}, "
+	  when "Ingredient 2" then ingredient2 = "#{CGI.escapeHTML(value)}, "
+	  when "Ingredient 3" then ingredient3 = "#{CGI.escapeHTML(value)}<br>"
+	  when "Chef" then chef = "<h3>Chef:</h3>#{CGI.escapeHTML(value)}<br>"
+       end
+   }
+   
+   title = "<h2><a href=\"#{link}\">#{title}</a>"
+   
+   outputFile.write( title )
+   outputFile.write( keywords )
+   outputFile.write( problem )
+   outputFile.write( solution )
+   outputFile.write( discussion )
+   outputFile.write( seeAlso )
+   outputFile.write( file )
+   outputFile.write( ingredient1)
+   outputFile.write( ingredient2 )
+   outputFile.write( ingredient3 )
+   outputFile.write( chef )
+   outputFile.write( "<HR>" )
+}
+outputFile.write( "</BODY>" )
+
+}