ipp_quickbase_devkit 0.0.1

data/examples/cookbookfiles/downloadFile.rb

@@ -0,0 +1,10 @@
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new
+
+# download the QuickBaseClient.rb.zip from record 24105 in the QuickBase Community Forum
+# '41' is the field ID of the File Attachment field
+qbc.downLoadFile("8emtadvk", "24105", "41" )
+
+# have to write the downloaded data before it exists on your local disk
+File.open( "The.Latest.QuickBaseClient.rb.zip", "wb" ){|f|f.write(qbc.fileContents)}

data/examples/cookbookfiles/downloadFilesToFolder.rb

@@ -0,0 +1,81 @@
+
+require 'QuickBaseClient'
+
+def downloadFiles1(username,password,cwd)
+  qbc = QuickBase::Client.new(username,password)
+  dbid = qbc.findDBByName(cwd)
+  qbc.getSchema(dbid)
+  dbid = qbc.lookupChdbid(cwd.dup)
+  downloadFiles3(qbc,username,password,dbid,"File Attachment")
+end
+
+def downloadFiles2(username,password,dbid,fieldName)
+  qbc = QuickBase::Client.new(username,password)
+  qbc.getSchema(dbid)
+  downloadFiles3(qbc,username,password,dbid,fieldName)
+end
+
+def downloadFiles3(qbc,username,password,dbid,fieldName)
+
+   fieldNames = qbc.getFieldNames(dbid)
+   clist = ""
+   fid = ""
+   fieldNames.each{|f|
+      id = qbc.lookupFieldIDByName(f)
+      fid = id.dup if f == fieldName
+      clist << id
+      clist << "."
+   }
+   clist[-1,1]=""
+
+   if fid == ""
+     fid = fieldName.dup
+     fieldName = qbc.lookupFieldNameFromID(fid)
+   end
+
+   qbc.iterateRecords(dbid,fieldNames,nil,nil,nil,clist,"3"){|r|
+      if r and r[fieldName] and r[fieldName].length > 0 
+         next if r[fieldName].include?("https:") or r[fieldName].include?("http:")
+         puts "Downloading #{r[fieldName]}"
+         qbc.downLoadFile(dbid,r["Record ID#"],fid)
+         if qbc.fileContents
+            filename = r[fieldName]
+            File.open( filename, "wb" ){|f|
+               f.write(qbc.fileContents)
+            }
+         end   
+      end
+   }
+  puts "\nFinished downloading files in QuickBase Record ID# order."
+  puts "(Later copies of files overwrite previous copies)."
+  puts "\nYou can repeat this download using downloadFilesToFolder.exe #{username} #{password} #{dbid} #{fid}."
+end
+
+def getInputAndRun
+   mycwd = Dir.pwd.gsub('/','\\')
+
+   if ARGV[3]
+     downloadFiles2(ARGV[0],ARGV[1],ARGV[2],ARGV[3])
+   else
+   
+     print "\nPlease enter your QuickBase username: "
+     username = gets.chomp
+     print "\nPlease enter your QuickBase password: "
+     password = gets.chomp
+     print "\nEnter 'y' if to download the files from a '#{mycwd}' QuickBase application: "
+     y = gets.chomp
+     
+     if y == "y" or y == "Y"
+       downloadFiles1(username,password,mycwd)
+     else
+       print "\nPlease enter the id of your QuickBase table: "
+       dbid = gets.chomp
+       print "\nPlease enter the name or id of the QuickBase File Attachment field in your table. (e.g. File): "
+       fieldName = gets.chomp
+       downloadFiles2(username,password,dbid,fieldName)
+     end
+   end
+
+end
+
+getInputAndRun

data/examples/cookbookfiles/downloadToTextFile.rb

@@ -0,0 +1,64 @@
+
+require 'QuickBaseTextData'
+
+# download the Ingredients table in the QuickBase API Cookbook v2 to a text file
+QuickBase::TextData.downloadData("username","password","bb2mad4ss")
+
+=begin 
+
+The 'downloadData' line above will write a file called 'downloadedTextData.txt' in your current directory.
+The contents will be something close to the text below. You can edit the text and send it back to QuickBase
+using QuickBase::TextData.uploadData("username","password","downloadedTextData.txt")
+
+dbid:bb2mad4ss
+record:1
+Name:Ruby wrapper for QuickBase HTTP API
+Description:This is a Ruby language wrapper for the QuickBase HTTP API. It includes routines for all everything in the API, plus additional routines to reduce the amount of code you have to write to get things done using the QuickBase API.
+File Attachment:
+URL:https://www.quickbase.com/db/8emtadvk?a=dr&r=ztj&rl=cjtm
+Contact E-mail:
+record:2
+Name:QuickBase HTTP API
+Description:
+File Attachment:
+URL:https://www.quickbase.com/up/6mztyxu8/g/rc7/en/va/QuickBaseAPI.htm
+Contact E-mail:
+record:3
+Name:One-Click Ruby Installer for Windows
+Description:This is a [one-click, self-contained Windows installer] that contains the Ruby language itself, dozens of popular extensions and packages, a syntax-highlighting editor and execution environment, and a Windows help file that contains the full text of the book, Programming Ruby: The Pragmatic Programmer's Guide. 
+File Attachment:
+URL:http://rubyinstaller.rubyforge.org/wiki/wiki.pl
+Contact E-mail:
+record:4
+Name:Visual Basic SDK
+Description:
+File Attachment:
+URL:https://www.quickbase.com/db/6mztyxu8?a=dr&r=c4
+Contact E-mail:
+record:5
+Name:Perl SDK
+Description:
+File Attachment:
+URL:https://www.quickbase.com/db/6mztyxu8?a=dr&r=c5
+Contact E-mail:
+record:6
+Name:Javascript SDK
+Description:
+File Attachment:
+URL:https://www.quickbase.com/db/6mztyxu8?a=dr&r=c8
+Contact E-mail:
+record:7
+Name:Java SDK
+Description:
+File Attachment:
+URL:https://www.quickbase.com/db/6mztyxu8?a=dr&r=c6
+Contact E-mail:
+record:8
+Name:Excel
+Description:
+File Attachment:
+URL:
+Contact E-mail:
+
+
+=end

data/examples/cookbookfiles/dumpSchema.rb

@@ -0,0 +1,11 @@
+
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new(ARGV[0],ARGV[1])
+qbc.getSchema(ARGV[2])
+File.open("#{ARGV[2]}.schema.xml","w"){|f|f.write(qbc.qdbapi)}
+
+# run this using 'ruby dumpSchema.rb <username> <password> <tableID>'
+# e.g. 'ruby dumpSchema.rb fred@flinstone wilma 8emtadvk'
+
+

data/examples/cookbookfiles/duplicateRecord.rb

@@ -0,0 +1,8 @@
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new( "my_username", "my_password", "my_application" )
+
+# make 6 copies of record 1
+qbc.copyRecord( "1", 6 )
+
+qbc.signOut

data/examples/cookbookfiles/dynamicMethods.rb

@@ -0,0 +1,33 @@
+
+
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new
+
+puts "\n\nDescription of QuickBase API Cookbook application:\n\n"
+
+puts qbc.bcdcajmrf.xml_desc
+
+puts "\n\nIngredients from the QuickBase API Cookbook:\n\n"
+
+qbc.bcdcajmrh.qid_1.printChildElements(qbc.records)
+
+puts "\n\nValue of field 6 from record 24105 in table 8emtadvk:\n\n"
+
+puts qbc.dbid_8emtadvk.rid_24105.fid_6 # prints 'Ruby wrapper for QuickBase HTTP API'
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

data/examples/cookbookfiles/editRecords.rb

@@ -0,0 +1,15 @@
+
+require 'QuickBaseClient'
+require 'Date'
+
+# login and connect to the "Email Outbox" application
+qbc = QuickBase::Client.new("username","password","Email Outbox")
+
+# find the "Messages" table in the "Email Outbox" application
+outboxMessagesTable = qbc.lookupChdbid("Messages")
+
+today = Date.today
+today = today.strftime("%m-%d-%Y")
+
+# for every record that was created today, change the "from" field to "fred@bedrock.com" and the "to" field to "wilma@bedrock.com"
+qbc.editRecords(outboxMessagesTable,{"from"=>"fred@bedrock.com","to"=>"wilma@bedrock.com"},"{'1'.EX.'#{today}'}")

data/examples/cookbookfiles/findJohnsLast10Records.rb

@@ -0,0 +1,17 @@
+
+require 'QuickBaseClient'
+
+# change "username" "password" to your QuickBase username and password
+qbc =  QuickBase::Client.new("username","password")
+
+communityForumRecords = qbc.getAllValuesForFields("8emtadvk",["Subject","Message"],"{'4'.CT.', John'}",nil,nil,"6.10",nil,"structured","num-10")
+
+puts "\n --- Ten most recent QuickBase Community Forum Records owned by ', John' ---\n\n"
+
+numRecords = communityForumRecords["Subject"].length
+(0..(numRecords-1)).each{|index|
+   print "\n#{index+1})\nSubject: "
+   print communityForumRecords["Subject"][index]
+   puts "\nMessage:"
+   puts communityForumRecords["Message"][index].gsub!("<BR/>","\n")
+}

data/examples/cookbookfiles/findRubyRecords.rb

@@ -0,0 +1,17 @@
+
+require 'QuickBaseClient'
+
+# change "username" "password" to your QuickBase username and password
+qbc =  QuickBase::Client.new("username","password")
+
+communityForumRecords = qbc.getAllValuesForFields("8emtadvk",["Subject","Message"],"{'0'.CT.'ruby'}",nil,nil,"6.10")
+
+puts "\n --- QuickBase Community Forum Records containing the word 'ruby' ---\n\n"
+
+numRecords = communityForumRecords["Subject"].length
+(0..(numRecords-1)).each{|index|
+   print "\nSubject: "
+   print communityForumRecords["Subject"][index]
+   puts "\nMessage:"
+   puts communityForumRecords["Message"][index].gsub!("<BR/>","\n")
+}

data/examples/cookbookfiles/formatCurrency.rb

@@ -0,0 +1,24 @@
+
+require 'QuickBaseClient'
+
+# change "username" "password" to your QuickBase username and password
+qbc =  QuickBase::Client.new("username","password")
+
+# read and format the "currency" field from all the records in a table
+qbc.iterateRecords("dbiddbid",["currency"]){|rec|
+  formattedValue  = qbc.formatCurrency(rec['currency'],{"currencySymbol" => "$"})
+  puts "Raw currency value from QuickBase: #{rec['currency']}, Formatted value: #{formattedValue}"
+}
+
+=begin
+
+Sample output from this script:
+
+Raw currency value from QuickBase: 7.33, Formatted value: $7.33
+Raw currency value from QuickBase: 0.33, Formatted value: $0.33
+Raw currency value from QuickBase: 1.01, Formatted value: $1.01
+Raw currency value from QuickBase: 1888888.00, Formatted value: $1888888.00
+Raw currency value from QuickBase: 1111.1111, Formatted value: $1111.1111
+Raw currency value from QuickBase: 23.23, Formatted value: $23.23
+
+=end

data/examples/cookbookfiles/formatDate.rb

@@ -0,0 +1,10 @@
+
+require 'QuickBaseClient'
+
+# change "username" "password" to your QuickBase username and password
+qbc =  QuickBase::Client.new("username","password")
+createdFieldValue = qbc.getAllValuesForFields("8emtadvk",["Created"],"{'3'.EX.'24105'}")
+createdFieldValue = createdFieldValue["Created"][0]
+formattedCreatedFieldValue  = qbc.formatDate(createdFieldValue)
+puts "Message 24105 in the QuickBase Community Forum was created on #{formattedCreatedFieldValue} (#{createdFieldValue})."
+

data/examples/cookbookfiles/formatDuration.rb

@@ -0,0 +1,27 @@
+
+require 'QuickBaseClient'
+
+# change "username" "password" to your QuickBase username and password
+qbc =  QuickBase::Client.new("username","password")
+
+# read and format the "duration" field from all the records in a table
+qbc.iterateRecords("dbiddbid",["duration"]){|rec|
+  rawValue = rec['duration']
+  days = qbc.formatDuration(rawValue.dup,"days")
+  hours  = qbc.formatDuration(rawValue.dup,"hours")
+  minutes  = qbc.formatDuration(rawValue.dup,"minutes")
+  printf("Raw value: %-15s Days: %-10s Hours: %-10s Minutes: %-10s\n", rec['duration'], days, hours, minutes)
+}
+
+=begin
+
+Sample output from this script:
+
+Raw value: 172800000       Days: 2          Hours: 48         Minutes: 2880
+Raw value: 285120000       Days: 3          Hours: 79         Minutes: 4752
+Raw value: 2160000000      Days: 25         Hours: 600        Minutes: 36000
+Raw value: 10658304000     Days: 123        Hours: 2960       Minutes: 177638
+Raw value: 37152000        Days: 0          Hours: 10         Minutes: 619
+Raw value: 86400000        Days: 1          Hours: 24         Minutes: 1440
+
+=end

data/examples/cookbookfiles/formatPercent.rb

@@ -0,0 +1,24 @@
+
+require 'QuickBaseClient'
+
+# change "username" "password" to your QuickBase username and password
+qbc =  QuickBase::Client.new("username","password")
+
+# read and format the "percent" field from all the records in a table
+qbc.iterateRecords("dbiddbid",["percent"]){|rec|
+  formattedValue  = qbc.formatPercent(rec['percent'])
+  puts "Raw percent value from QuickBase: #{rec['percent']}, Formatted value: #{formattedValue}"
+}
+
+=begin
+
+Sample output from this script:
+
+Raw percent value from QuickBase: 0.005, Formatted value: 0.5
+Raw percent value from QuickBase: 0.12, Formatted value: 12
+Raw percent value from QuickBase: 0.9999, Formatted value: 99.99
+Raw percent value from QuickBase: 0.5, Formatted value: 50
+Raw percent value from QuickBase: 0.13, Formatted value: 13
+Raw percent value from QuickBase: 0.33123, Formatted value: 33.12
+
+=end

data/examples/cookbookfiles/getAllValuesForFields.rb

@@ -0,0 +1,18 @@
+
+require 'QuickBaseClient'
+
+# change "username" "password" to your QuickBase username and password
+qbc =  QuickBase::Client.new("username","password")
+
+cookbookRecords = qbc.getAllValuesForFields("bb2mad4sr",["Title","Keywords"])
+
+puts "\n --- QuickBase API Cookbook v2 ---\n\n"
+
+numRecords = cookbookRecords["Title"].length
+(0..(numRecords-1)).each{|index|
+   print "Title: "
+   print cookbookRecords["Title"][index]
+   print "  (Keywords: "
+   print cookbookRecords["Keywords"][index]
+   puts ")"
+}

data/examples/cookbookfiles/getAppDTMInfo.rb

@@ -0,0 +1,29 @@
+
+
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new
+
+puts "\n\nDate/time information about the QuickBase Community Forum:\n\n"
+
+qbc.getAppDTMInfo("bbqm84dzy")
+
+puts "Time of request                : #{qbc.formatFieldValue(qbc.requestTime.text,'timestamp')}"
+puts "Time next request allowed      : #{qbc.formatFieldValue(qbc.requestNextAllowedTime.text,'timestamp')}"
+puts "Time application last modified : #{qbc.formatFieldValue(qbc.lastModifiedTime,'timestamp')}"
+puts "Time any record last modified  : #{qbc.formatFieldValue(qbc.lastRecModTime,'timestamp')}"
+
+   
+=begin
+
+Output of the above script:
+
+Date/time information about the QuickBase Community Forum:
+
+Time of request                : 05-03-2009 03:52 PM
+Time next request allowed      : 05-03-2009 03:52 PM
+Time application last modified : 03-26-2009 01:55 PM
+Time any record last modified  : 05-02-2009 10:10 AM
+
+=end
+

data/examples/cookbookfiles/getApplicationVariable.rb

@@ -0,0 +1,5 @@
+require 'QuickBaseClient'
+qbc = QuickBase::Client.new("username","password","My Application Name")
+puts qbc.getApplicationVariable("var")
+p qbc.getApplicationVariable
+

data/examples/cookbookfiles/getChildTableDBID.rb

@@ -0,0 +1,11 @@
+
+require 'QuickBaseClient'
+
+# change "username" "password" to your QuickBase username and password
+qbc =  QuickBase::Client.new("username","password")
+qbc.printRequestsAndResponses=true 
+applicationDBID = qbc.findDBByname("QuickBase API Cookbook v2")
+qbc.getSchema(applicationDBID)
+childDBID = qbc.lookupChdbid("Ingredients")
+puts "The dbid of the 'Ingredients' table in the QuickBase API Cookbook v2 application is #{childDBID}"
+

data/examples/cookbookfiles/getColumnListForReport.rb

@@ -0,0 +1,6 @@
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new
+qbc.getSchema("8emtadvk")
+puts "Columns for QuickBase Community Forum 'List all' report: #{qbc.getColumnListForQuery(nil,'List All')}"
+puts "Columns for QuickBase Community Forum 'List all' report: #{qbc.getColumnListForQuery("1",nil)}"

data/examples/cookbookfiles/getFieldChoices.rb

@@ -0,0 +1,13 @@
+
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new("username","password")
+
+# get the available choices for the 'Ingredient 1' field in the 
+# 'Recipes' table of the 'QuickBase API Cookbook v2' application
+choices = qbc.getFieldChoices( "bb2mad4sr", "Ingredient 1" )
+
+if choices
+   puts "\n------ Ingredients choices from the QuickBase API Cookbook v2 ------\n\n"
+   puts choices.join("\n") 
+end