ipp_quickbase_devkit 0.0.1

data/examples/cookbookfiles/iterateDBPages.rb

@@ -0,0 +1,8 @@
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new
+
+# List the Pages from the QuickBase Support Center
+qbc.iterateDBPages("9kaw8phg"){|page|
+  puts "Page: #{page['name']}, Type: #{page['type']}, ID: #{page['id']}\n" 
+}

data/examples/cookbookfiles/iterateFilteredRecords.rb

@@ -0,0 +1,12 @@
+
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new
+
+puts "----------------------------------------------------------------------"
+puts "Latest Community Forum records with Subject beginning with A through E"
+puts "----------------------------------------------------------------------"
+
+qbc.iterateFilteredRecords("8emtadvk",[{"Subject"=>"^[A-E].+"}],nil,nil,"List Changes",nil,nil,"structured","num-100") {|record|
+   puts record["Subject"]
+}

data/examples/cookbookfiles/iterateJoinRecords.rb

@@ -0,0 +1,68 @@
+
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new("username","password")
+
+# make a list of the tables to be joined
+tablesToJoin = Array.new
+
+table1 = Hash.new
+table1["dbid"]="bccr737mz"              #table id
+table1["fields"] = Array["a","b","c"] #fields to retrieve
+table1["joinfield"] = "c"                 #field to compare across all tables' records
+tablesToJoin << table1
+
+table2 = Hash.new
+table2["dbid"]="bccr737m2"
+table2["fields"] = Array["c","d","e"]
+table2["joinfield"] = "c"
+tablesToJoin << table2
+
+table3 = Hash.new
+table3["dbid"]="bccr737m3"
+table3["fields"] = Array["cc","g","gf"]
+table3["joinfield"] = "cc"
+tablesToJoin << table3
+
+puts "------ Joined records from 3 tables ------"
+recnum = 1
+qbc.iterateJoinRecords(tablesToJoin) {|joinedRecord|
+   print "\n#{recnum}. "
+   joinedRecord.each{|field,value|
+      print "#{field}: #{value}, "
+   }
+   recnum += 1
+}
+
+=begin
+
+The output using unrealistically simple data is below.
+Note that field 'c' is in two tables and is merged.
+The value of 'c' from the second table is included in the joined record.
+
+------ Joined records from 3 tables ------
+
+1. cc: c, a: a2, b: b2, c: c, d: d, e: e, g: g, gf: sda,
+2. cc: c, a: a2, b: b2, c: c, d: sadf, e: df, g: cv, gf: sdafad,
+3. cc: c, a: a2, b: b2, c: c, d: sadf, e: df, g: sad, gf: sad,
+4. cc: c, a: a2, b: b2, c: c, d: d, e: e, g: sad, gf: sad,
+5. cc: c, a: a2, b: b2, c: c, d: sadf, e: df, g: g, gf: sda,
+6. cc: c, a: a2, b: b2, c: c, d: sadf, e: df, g: cv, gf: sdafad,
+7. cc: c, a: a2, b: b2, c: c, d: d, e: e, g: sad, gf: sad,
+8. cc: c, a: a2, b: b2, c: c, d: sadf, e: df, g: sad, gf: sad,
+9. cc: c, a: a2, b: b2, c: c, d: sadf, e: df, g: g, gf: sda,
+10. cc: c, a: a2, b: b2, c: c, d: d, e: e, g: cv, gf: sdafad,
+11. cc: c, a: a2, b: b2, c: c, d: sadf, e: df, g: sad, gf: sad,
+12. cc: c, a: a, b: b, c: c, d: d, e: e, g: g, gf: sda,
+13. cc: c, a: a, b: b, c: c, d: sadf, e: df, g: cv, gf: sdafad,
+14. cc: c, a: a, b: b, c: c, d: sadf, e: df, g: sad, gf: sad,
+15. cc: c, a: a, b: b, c: c, d: d, e: e, g: sad, gf: sad,
+16. cc: c, a: a, b: b, c: c, d: sadf, e: df, g: g, gf: sda,
+17. cc: c, a: a, b: b, c: c, d: sadf, e: df, g: cv, gf: sdafad,
+18. cc: c, a: a, b: b, c: c, d: d, e: e, g: sad, gf: sad,
+19. cc: c, a: a, b: b, c: c, d: sadf, e: df, g: sad, gf: sad,
+20. cc: c, a: a, b: b, c: c, d: sadf, e: df, g: g, gf: sda,
+21. cc: c, a: a, b: b, c: c, d: d, e: e, g: cv, gf: sdafad,
+22. cc: c, a: a, b: b, c: c, d: sadf, e: df, g: sad, gf: sad,
+
+=end

data/examples/cookbookfiles/iterateRecordInfos.rb

@@ -0,0 +1,8 @@
+require 'QuickBaseClient'
+
+puts "\n\nQuickBase Formula Functions Reference:\n\n"
+
+QuickBase::Client.new.iterateRecordInfos("6ewwzuuj"){|ri|  
+  puts "------------------------------"
+  ri.each{|field,value| puts "#{field}: #{value}\n"}
+}

data/examples/cookbookfiles/iterateRecords.rb

@@ -0,0 +1,23 @@
+
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new
+puts " ---------- Records from the QuickBase Community Forum containing 'Ruby wrapper' ----------"
+
+recordNumber=1
+
+qbc.iterateRecords("8emtadvk",["Subject","Created","Message"],"{'0'.CT.'Ruby wrapper'}") {|record|
+
+   print "\n\n#{recordNumber}."
+   
+   print "\nSubject: ", record["Subject"] 
+   
+   print "\nCreated: ", qbc.formatDate(record["Created"]) 
+   
+   message = record["Message"]
+   message.gsub!("<BR/>","\n") if message.include?("<BR/>")
+   
+   print "\nMessage: ", message
+   
+   recordNumber += 1
+}

data/examples/cookbookfiles/iterateSummaryRecords.rb

@@ -0,0 +1,13 @@
+
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new("username","password")
+
+puts "\nSummary of types of published applications in the QuickBase Application Library:\n"
+printf( "\n%-20s %10s %10s","Type","Count","Popularity\n")
+qbc.iterateSummaryRecords("bbtt9cjr7", ["Type","Popularity"]){|record|
+   if record["Type"]
+      printf( "\n%-20s %10s %10s",record["Type"],record["Count"],record["Popularity:Total"])
+   end
+}
+puts "\n\nCompare the output to Summary at the bottom of this report - \n\nhttps://www.quickbase.com/db/bbtt9cjr7?a=q&qid=28\n\n"

data/examples/cookbookfiles/iterateUnionRecords.rb

@@ -0,0 +1,38 @@
+
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new("username","password")
+
+# make a list of the tables to be merged
+table1 = Hash.new
+table1["dbid"]="bccr737mz"
+table2 = Hash.new
+table2["dbid"]="bccr737m2"
+tablesToMerge = Array[table1,table2]
+
+# fields are expected to be the same in both tables
+fields = Array["c"]
+
+puts "------ Merged records from 2 tables ------"
+recnum = 1
+qbc.iterateUnionRecords(tablesToMerge,fields) {|uniqueRecord|
+   print "\n#{recnum}. "
+   uniqueRecord.each{|field,value|
+      print "#{field}: #{value}, "
+   }
+   recnum += 1
+}
+
+=begin
+
+The output using unrealistically simple data is below.
+
+------ Merged records from 2 tables ------
+
+1. c: ad,
+2. c: c,
+3. c: c1,
+4. c: v,
+5. c: Get records containing a certain value,
+
+=end

data/examples/cookbookfiles/listAccessibleApplications.rb

@@ -0,0 +1,6 @@
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new("username","password")
+qbc.grantedDBs() { |database|
+   qbc.printChildElements(database)
+}

data/examples/cookbookfiles/logRequestAndResponseXML.rb

@@ -0,0 +1,8 @@
+
+require 'QuickBaseClient'
+
+# change "username" "password" to your QuickBase username and password
+qbc = QuickBase::Client.new("username","password")
+puts "Logging XML requests and responses in file logfile.csv."
+qbc.logToFile( "logfile.csv" )
+qbc.getSchema("8emtadvk") #QuickBase Community Forum database

data/examples/cookbookfiles/lookupFieldPropertyByName.rb

@@ -0,0 +1,62 @@
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new
+
+qbc.getSchema("8emtadvk")
+showTimeInDateModified = qbc.lookupFieldPropertyByName("Date Modified","display_time") == "1" ? "is" : "is not"
+
+puts "\nFor the Date Modified field in the QuickBase Community Forum, the time of day #{showTimeInDateModified} displayed.\n"
+
+puts "\nThe field properties you can lookup are: \n\n"
+puts qbc.validFieldProperties.join("\n")
+
+=begin
+
+The above code prints -
+
+
+For the Date Modified field in the QuickBase Community Forum, the time of day is displayed.
+
+The field properties you can lookup are:
+
+allowHTML
+allow_new_choices
+appears_by_default
+append_only
+blank_is_zero
+bold
+carrychoices
+comma_start
+cover_text
+decimal_places
+default_kind
+default_today
+display_dow
+display_month
+display_relative
+display_time
+display_today
+display_user
+display_zone
+does_average
+does_total
+doesdatacopy
+exact
+find_enabled
+foreignkey
+label
+nowrap
+num_lines
+required
+sort_as_given
+unique
+use_new_window
+target_dbid
+target_dbname
+target_fieldname
+target_fid
+source_fieldname
+source_fid
+
+=end
+

data/examples/cookbookfiles/lookupFieldTypeByName.rb

@@ -0,0 +1,10 @@
+
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new
+
+qbc.getSchema("8emtadvk") #Messages table in QuickBase Community Forum
+
+puts qbc.lookupFieldTypeByName("Thread")
+
+# the line above prints "url" on the screen

data/examples/cookbookfiles/makeCSVFile.rb

@@ -0,0 +1,4 @@
+require 'QuickBaseClient'
+qbc = QuickBase::Client.new( "my_username", "my_password", "My QuickBase Database" )
+qbc.makeSVFile( "MyCSVFile.csv" )
+qbc.signOut

data/examples/cookbookfiles/makeSlideShow.rb

@@ -0,0 +1,42 @@
+require 'QuickBaseClient'
+require 'QuickBaseMisc'
+
+username = ARGV[0] || ENV["quickbase_username"] 
+password = ARGV[1] || ENV["quickbase_password"] 
+
+qbc = QuickBase::Client.new(username,password)
+
+cwd = Dir.pwd.gsub('/','\\')
+
+dbid = qbc.findDBByName(cwd)
+if dbid.nil?
+  dbid = qbc.createDatabase(cwd,"#{username}'s slide show from #{cwd}.")
+  qbc.addField(dbid,"Picture","file")
+  qbc.addField(dbid,"HtmlPage","file")
+else  
+  qbc.getSchema(dbid)
+  dbid = qbc.lookupChdbid(cwd.dup)
+  qbc.getSchema(dbid)
+end  
+pictureFieldID = QuickBase::Misc.decimalToBase32(6)
+htmlPageFieldID = QuickBase::Misc.decimalToBase32(7)
+Dir.foreach(cwd){|file|
+  next unless [".jpeg", ".jpg",".gif",".bmp",".png"].include?(file.downcase[file.rindex('.'),file.length])
+  renamedFile = file.dup
+  renamedFile.gsub!("&","And")
+  renamedFile.gsub!("'"," ")
+  if renamedFile != file
+     File.rename(file,renamedFile)
+  end
+  puts "Uploading #{renamedFile}"
+  rid, updateid = qbc.uploadFile(dbid, renamedFile.dup, "Picture")
+  thisRid = QuickBase::Misc.decimalToBase32(rid.to_i)
+  prevRid = QuickBase::Misc.decimalToBase32(rid.to_i-1)
+  nextRid = QuickBase::Misc.decimalToBase32(rid.to_i+1)
+  pictureURL = "https://www.quickbase.com/up/#{dbid}/g/r#{thisRid}/e#{pictureFieldID}/va/#{renamedFile.dup}"
+  prevHtmlURL = "https://www.quickbase.com/up/#{dbid}/g/r#{prevRid}/e#{htmlPageFieldID}/va/slide.html"
+  nextHtmlURL = "https://www.quickbase.com/up/#{dbid}/g/r#{nextRid}/e#{htmlPageFieldID}/va/slide.html"
+  html = "<center><img src=\"#{pictureURL}\" /><br>#{renamedFile.dup}<b>#{}</b><hr><a href=\"#{prevHtmlURL}\">Previous</a> <a href=\"#{nextHtmlURL}\">Next</a></center>"
+  File.open("slide.html","w"){|f|f.write(html)}
+  qbc.updateFile(dbid,rid,"slide.html","HtmlPage")
+}

data/examples/cookbookfiles/makerecs.rb

@@ -0,0 +1,64 @@
+
+require 'QuickBaseClient'
+
+#
+# This script reads the list of records from a Documents table and a Doctors table
+# And creates mssing records in a Progress table for all the combinations of Doctors and Documents
+#
+
+# Check the command line for username, password ---------------------
+if ARGV.length == 1 and ARGV[0] == "?"
+   puts "\n\nUsage: ruby makerecs.rb username password\n\nThis program adds records to the Progress table\nfor each record added to the Documents table.\n\n"
+   exit 1 
+elsif ARGV.length > 1
+   username = ARGV[0]
+   password = ARGV[1]
+else
+   puts "\nPlease enter your username and password, e.g.\n\n\truby makerecs.rb fred amliw\n\n"
+   exit 1 
+end
+
+documentsDBID = "xxxxxxxxx" # fictitious!   please use a valid table dbid
+doctorsDBID = "yyyyyyyyy" # fictitious!   please use a valid table dbid
+progressDBID = "zzzzzzzzz" # fictitious!   please use a valid table dbid
+
+# Signin  to QuickBase ----------------------------------------------
+qbc = QuickBase::Client.new( username, password )
+
+# Collect the record IDs from the Documents table -------------------
+documentRids = qbc.getAllRecordIDs( documentsDBID ) #Documents table
+puts "Document IDs = #{documentRids.join( ',' )}"
+
+# Collect the record IDs from the Doctors table ---------------------
+doctorRids = qbc.getAllRecordIDs( doctorsDBID ) #Doctors table
+puts "Doctor IDs = #{doctorRids.join( ',' )}"
+
+# Collect the Document and Doctor IDs from the Progress table -------
+progressIDs = qbc.getAllValuesForFields( progressDBID, [ "DoctorID", "DocumentID" ] ) # Progress table
+
+puts "Progress Document IDs = #{progressIDs["DocumentID"].join(',')}"
+puts "Progress Doctor IDs = #{progressIDs["DoctorID"].join(',')}"
+
+# Collect the Documents that are missing from the Progress table ----------------
+missingProgressDocuments = Array.new
+documentRids.each{ |documentRid| 
+        if not progressIDs["DocumentID"].include?( documentRid )
+           missingProgressDocuments << documentRid
+        end
+   }
+
+puts "Missing Progress Document IDs = #{missingProgressDocuments.join(',')}"
+
+# For each missing Document, add a record to the Progress table for each Doctor -
+missingProgressDocuments.each{ |documentRid|
+   doctorRids.each{ |doctorRid|
+      qbc.clearFieldValuePairList
+      qbc.addFieldValuePair( "DocumentID", nil, nil, documentRid )
+      fieldValueList = qbc.addFieldValuePair( "DoctorID", nil, nil, doctorRid )
+      qbc.addRecord( progressDBID, fieldValueList )
+   }
+}
+
+# Signout from QuickBase --------------------------------------------
+qbc.signOut
+

data/examples/cookbookfiles/max.rb

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

data/examples/cookbookfiles/min.rb

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