ipp_quickbase_devkit 0.0.1

data/examples/cookbookfiles/recordAndFieldIterator.rb

@@ -0,0 +1,24 @@
+
+require 'QuickBaseClient'
+
+# change "username" "password" to your QuickBase username and password
+qbc =  QuickBase::Client.new("username","password")
+
+qbc.doQuery("6ewwzuuj")
+
+puts "\n --- QuickBase Formula Functions Reference ---\n\n"
+
+recordNumber = 1
+qbc.eachRecord(qbc.records){|record|
+   puts "\n --- Record #{recordNumber} ---"
+   recordNumber += 1
+   qbc.eachField(record){|field|
+      print qbc.lookupFieldNameFromID(field.attributes["id"])
+      print ": "
+      if field.has_text?
+         text =  field.text.dup
+         text.gsub!("<BR/>","\n") if text.include?("<BR/>")
+         puts text 
+      end
+   }
+}

data/examples/cookbookfiles/runImport.rb

@@ -0,0 +1,9 @@
+
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new("username","password")
+
+# run pre-defined Import #3 into table bcdcajmrf
+
+qbc.runImport("bcdcajmrf","3")
+

data/examples/cookbookfiles/runQuickBaseTwitterConnector.rb

@@ -0,0 +1,41 @@
+require 'QuickBaseTwitterConnector'
+
+QuickBase::TwitterConnector.new
+
+=begin
+
+This is a example of what you will see.
+The Twitter Connector will run in a loop, checking for new information every few minutes.
+Probably the most useful feature of this Connector is the ability to send two types of
+automated response, static text and the results from simple REST queries. 
+Remember that Twitter only accepts the first 140 characters of text.
+
+The Connector automatically creates a QuickBase application using your QuickBase
+username and your Twitter username.
+
+----------------------------------------------------------------------------------
+
+Please enter the Quickbase username to use for this session: fred_flintstone@internet.com
+Please enter the Quickbase password to use for this session: wilma
+Please enter the Twitter username to use for this session: fred_flintstone
+Please enter the Twitter password to use for this session: wilma
+
+
+Please enter a number to select the connection type:
+
+1 - Send Twitter messages to QuickBase.
+2 - Send QuickBase messages to Twitter.
+3 - Exchange messages between QuickBase and Twitter.
+4 - Send automated replies from QuickBase to Twitter.
+5 - All the above.
+
+5
+
+
+Getting 'friends' Twitter Status since Fri, 28 Mar 2008 13:47:24 -0700.
+Getting Direct Messages from Twitter since Fri, 28 Mar 2008 13:47:24 -0700.
+Sending messages from QuickBase to Twitter added since Fri, 28 Mar 2008 13:47:24 -0700.
+Getting Direct Messages from Twitter since Fri, 28 Mar 2008 13:47:24 -0700.
+Automated Direct Message sent to wilma_flintstone: what's for dinner?: rex ribs
+
+=end

data/examples/cookbookfiles/sendToQuickBase.rb

@@ -0,0 +1,33 @@
+require 'QuickBaseClient'
+
+if ARGV[0] and File.exist?(ARGV[0]) and ARGV[0].rindex("\\")
+  username = ARGV[1] || ENV["quickbase_username"]
+  password = ARGV[2] || ENV["quickbase_password"]
+  if username.nil?
+    print "Please enter your QuickBase user name: "
+    username = gets.chop
+  end
+  if password.nil?
+    print "Please enter your QuickBase password: "
+    password = gets.chop
+  end    
+  qbc = QuickBase::Client.new(username, password)
+  folder = ARGV[0][0,ARGV[0].rindex("\\")]
+  file = ARGV[0][ARGV[0].rindex("\\")+1,ARGV[0].length]
+  dbid = qbc.findDBByName(folder)
+  if dbid.nil?
+    dbid = qbc.createDatabase(folder,"Files uploaded from #{folder}")
+    qbc.addField(dbid, "Description","text")
+    qbc.addField(dbid, "File Attachment","file")
+  else
+    qbc.getSchema(dbid)
+    dbid = qbc.lookupChdbid(folder.dup)
+  end
+  Dir.chdir(folder)
+  qbc.uploadFile(dbid,file.dup,"File Attachment")
+else
+  puts "\n\nusage: ruby sendToQuickBase.rb <filepath> [username] [password]"
+  puts "\ne.g. ruby sendToQuickBase.rb c:\temp\mySpecialFile"
+  puts "\nYou can omit your username and password if they are in environment"
+  puts "variables 'quickbase_username' and 'quickbase_password'.\n\n"
+end

data/examples/cookbookfiles/setDBvar.rb

@@ -0,0 +1,6 @@
+
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new("username","password","My Appointments")
+
+qbc._setDBvar("HourlyRate","350.00")

data/examples/cookbookfiles/showRequestAndResponseXML.rb

@@ -0,0 +1,8 @@
+
+require 'QuickBaseClient'
+
+# change "username" "password" to your QuickBase username and password
+qbc = QuickBase::Client.new("username","password")
+qbc.printRequestsAndResponses = true
+puts "Show the XML request and response while getting info about the QuickBase Community Forum database."
+qbc.getDBInfo("8emtadvk")

data/examples/cookbookfiles/sqlQuery.rb

@@ -0,0 +1,11 @@
+
+require 'QuickBaseClient'
+qbc = QuickBase::Client.new("username","password","QuickBase Community Forum")
+recs = qbc.doSQLQuery("SELECT Subject,Message FROM Messages WHERE Subject = 'Ruby wrapper for QuickBase HTTP API'",:Array)
+recs.each{ |rec| 
+   subject = rec['Subject']
+   message = rec['Message']
+   message.gsub!("<BR/>","\n")
+   puts "Subject: --------------- #{subject} ---------------\nMessage: #{message}\n\n"
+}
+

data/examples/cookbookfiles/stopOnError.rb

@@ -0,0 +1,10 @@
+require 'QuickBaseClient.rb'
+
+begin
+   qbc = QuickBase::Client.new("username","password")
+   qbc.stopOnError=true
+   qbc.doQuery( "bad_database_id" ) # make a bad request
+   qbc.doQuery( "bb2mad4sr" ) # QuickBase API Cookbook v2
+rescue StandardError => exception
+   puts "\n\n ***** Something went wrong during a request to QuickBase: ****\n#{exception}"
+end

data/examples/cookbookfiles/sum.rb

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

data/examples/cookbookfiles/twitterFromQuickBase.rb

@@ -0,0 +1,42 @@
+
+require 'rubygems'
+gem 'twitter4r', '>=0.3.0'
+require 'twitter'
+
+require 'QuickBaseClient'
+
+print "Please enter your QuickBase username: "
+quickbase_username = gets.chop
+print "Please enter your QuickBase password: "
+quickbase_password = gets.chop
+qbc = QuickBase::Client.new(quickbase_username,quickbase_password)
+
+dbid = qbc.findDBByName("Twitter messages (#{quickbase_username})" )
+if dbid.nil?
+    dbid = qbc.createDatabase("Twitter messages (#{quickbase_username})", "This is a list of messages from Twitter.")
+    qbc.addField(dbid,"Twitter_Screen_Name", "text")
+    qbc.addField(dbid,"Twitter_Message", "text")
+else   
+  
+  messagesToMoveToTwitter = []
+  qbc.iterateRecords(dbid,["Record ID#","Twitter_Screen_Name","Twitter_Message"]){|record|
+    if record["Twitter_Screen_Name"].nil? or record["Twitter_Screen_Name"] == "" and record["Twitter_Message"] and record["Twitter_Message"] != ""       
+      messagesToMoveToTwitter << record["Twitter_Message"]
+      qbc.deleteRecord(dbid,record["Record ID#"])
+    end  
+  }
+  
+  if messagesToMoveToTwitter.length > 0
+    print "Please enter your Twitter username: "
+    twitter_username = gets.chop
+    print "Please enter your Twitter password: "
+    twitter_password = gets.chop
+    twitter_client = Twitter::Client.new(:login => twitter_username, :password => twitter_password )
+    
+    messagesToMoveToTwitter.each {|message|
+      Twitter::Status.create(:text => message,:client => twitter_client)
+    }
+    
+  end
+  
+end

data/examples/cookbookfiles/twitterWithQuickBase.rb

@@ -0,0 +1,36 @@
+
+require 'rubygems'
+gem 'twitter4r', '>=0.3.0'
+require 'twitter'
+
+# ----------------------------------------------------------------------
+require 'QuickBaseClient'
+
+print "Please enter your QuickBase username: "
+quickbase_username = gets.chop
+
+print "Please enter your QuickBase password: "
+quickbase_password = gets.chop
+
+qbc = QuickBase::Client.new(quickbase_username,quickbase_password)
+dbid = qbc.findDBByName("Twitter messages (#{quickbase_username})" )
+if dbid.nil?
+    dbid = qbc.createDatabase("Twitter messages (#{quickbase_username})", "This is a list of messages from Twitter.")
+    qbc.addField(dbid,"Twitter_Screen_Name", "text")
+    qbc.addField(dbid,"Twitter_Message", "text")
+end
+
+# ----------------------------------------------------------------------
+print "Please enter your Twitter username: "
+twitter_username = gets.chop
+
+print "Please enter your Twitter password: "
+twitter_password = gets.chop
+
+twitter_client = Twitter::Client.new(:login => twitter_username, :password => twitter_password )
+timeline = twitter_client.timeline_for(:public) do |status|
+  qbc.clearFieldValuePairList
+  qbc.addFieldValuePair("Twitter_Screen_Name",nil,nil,status.user.screen_name)
+  qbc.addFieldValuePair("Twitter_Message",nil,nil,status.text)
+  qbc.addRecord(dbid,qbc.fvlist)
+end

data/examples/cookbookfiles/uploadCSVData.rb

@@ -0,0 +1,20 @@
+require 'QuickBaseClient'
+
+#sign into your application using your user name and password
+qbc = QuickBase::Client.new( "my_username", "my_password", "my_application" )
+
+# If your application is a multi-table application, switch to the correct target table using lookupChdbid
+qbc.lookupChdbid( "Imported data" )
+
+# delete all the records in the "Imported data" table then
+# import new data from a CSV file. The field names must be at the top of the file.
+
+# Uncomment the following line to make your QuickBase table
+# have the same contents as your CSV file.
+#qbc._purgeRecords
+
+# (change 'ImportedData.csv' to a real file name)
+qbc.importCSVFile( "ImportedData.csv" )
+
+#sign out of QuickBase
+qbc.signOut

data/examples/cookbookfiles/uploadExcelData.rb

@@ -0,0 +1,22 @@
+
+require 'QuickBaseClient'
+
+#sign into a QuickBase application using your user name and password
+qbc = QuickBase::Client.new( "my_username", "my_password", "my_application" )
+
+# if your application is a multi-table application, switch 
+# to the right table
+qbc.lookupChdbid( "Imported Excel data" )
+
+# delete all the records in the "Imported Excel data" table then
+# import new data from an Excel file. The field names must be at the top of the file.
+# 'h' is the letter of the last column to import.
+# Note: any commas (',') in the data are converted to semi-colons (';').
+# Uncomment the following line if you want to make your QuickBase table match the contents of your Excel file.
+
+#qbc._purgeRecords
+
+qbc._importFromExcel( "ImportedExcelData.xls", 'h' )
+
+#sign out of QuickBase
+qbc.signOut

data/examples/cookbookfiles/uploadFileEveryHour.rb

@@ -0,0 +1,18 @@
+require 'QuickBaseClient'
+
+loop {
+  qbc = QuickBase::Client.new( "my_username", "my_password", "my_application" )
+  qbc.lookupChdbid( "Documents" ) # the table containing the files
+
+  # "12" is the number of the record (Record ID#) to be modified
+  # "Document" is the name of the field containing a file attachment
+  # "Version" and "Date" are additional field values to modify in the record
+
+  qbc.updateFile( qbc.dbid, "12", "my_file.doc", "Document", { "Version" => "6",   "Note" => "Updated 01/30/2006" } )
+
+  qbc.signOut
+  qbc = nil
+
+  # wait one hour
+  sleep(60*60)
+}

data/examples/cookbookfiles/uploadFileIntoNewRecord.rb

@@ -0,0 +1,8 @@
+
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new( "username", "password" )
+
+# upload the local file "cookbookfiles.zip" into the 'File Attachment' field in a new record 
+# in the 'Etc.' table in the QuickBase API Cookbook v2
+qbc.uploadFile( "bb2mad4su", "cookbookfiles.zip", "File Attachment" )

data/examples/cookbookfiles/uploadFilesFromFolder.rb

@@ -0,0 +1,69 @@
+
+require 'QuickBaseClient'
+
+def uploadFiles1(username,password,cwd)
+  qbc = QuickBase::Client.new(username,password)
+  dbid = qbc.findDBByName(cwd)
+  if dbid.nil?
+    puts "Creating a QuickBase application called '#{cwd}'."
+    dbid = qbc.createDatabase(cwd,"Files uploaded from #{username}\'s #{cwd} folder.")
+    qbc.addField(dbid, "Description","text")
+    qbc.addField(dbid, "File Attachment","file")
+  else
+    puts "\nUsing the existing QuickBase application called '#{cwd}'.\n"
+    qbc.getSchema(dbid)
+    dbid = qbc.lookupChdbid(cwd.dup)
+  end
+  uploadFiles3(qbc,dbid,"File Attachment",cwd)
+  puts "\nYou can repeat this upload using uploadFilesFromFolder.exe #{username} #{password} #{dbid} file_attachment"
+end
+
+def uploadFiles2(username,password,dbid,fieldName,cwd)
+  qbc = QuickBase::Client.new(username,password)
+  uploadFiles3(qbc,dbid,fieldName,cwd)
+  puts "\nYou can repeat this upload using uploadFilesFromFolder.exe #{username} #{password} #{dbid} #{fieldName.gsub( /\W/, '_' )}."
+end
+
+def uploadFiles3(qbc,dbid,fieldName,cwd)
+  Dir.foreach(cwd){|file|
+    next if file == "." or file == ".."
+    renamedFile = file.dup
+    renamedFile.gsub!("&","And")
+    renamedFile.gsub!("'"," ")
+    if renamedFile != file
+       File.rename(file,renamedFile)
+    end
+    puts "Uploading #{renamedFile}"
+    qbc.uploadFile(dbid,renamedFile,fieldName)
+  }
+  puts "\nFinished uploading files."
+end
+
+def getInputAndRun
+   mycwd = Dir.pwd.gsub('/','\\')
+
+   if ARGV[3]
+     uploadFiles2(ARGV[0],ARGV[1],ARGV[2],ARGV[3],mycwd)
+   else
+   
+     print "\nPlease enter your QuickBase username: "
+     username = gets.chomp
+     print "\nPlease enter your QuickBase password: "
+     password = gets.chomp
+     print "\nEnter 'y' if to use or create a '#{mycwd}' QuickBase application for the files: "
+     y = gets.chomp
+     
+     if y == "y" or y == "Y"
+       uploadFiles1(username,password,mycwd)
+     else
+       print "\nPlease enter the id of your target QuickBase table: "
+       dbid = gets.chomp
+       print "\nPlease enter the name of the QuickBase File Attachment field in your table. (e.g. File): "
+       fieldName = gets.chomp
+       uploadFiles2(username,password,dbid,fieldName,mycwd)
+     end
+   end
+
+end
+
+getInputAndRun

data/examples/cookbookfiles/useCompanyURL.rb

@@ -0,0 +1,12 @@
+
+require 'QuickBaseClient'
+
+#There are two ways to set the URL for your company
+
+# 1)
+qbc1 = QuickBase::Client.new( "fred_flinstone@internet.com", "wilma", nil, true, false, false, false, "mycompany" )
+
+# 2)
+qbc2 = QuickBase::Client.new( "fred_flinstone@internet.com", "wilma")
+qbc2.setqbhost( true, "mycompany" )
+

data/examples/cookbookfiles/userRoles.rb

@@ -0,0 +1,49 @@
+
+
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new("username","password","My Application")
+
+qbc._userRoles() { |user|
+  qbc.printChildElements( user )
+}
+
+=begin
+
+Approximate output of above script:
+
+user (id=3453444.csw ):
+ name  = Fred Flintstone
+ lastAccess  = 1241207132457
+ firstName  = Fred
+ lastName  = Flintstone
+ roles :
+  role (id=18 ):
+   name  = Participant with Modify Own
+   access (id=3 ) = Basic Access
+user (id=345434444.bpw5 ):
+ name  = Wilma Flintstone
+ lastAccess  = 1240232570603
+ firstName  = Wilma
+ lastName  = Flintstone
+ roles :
+  role (id=18 ):
+   name  = Participant with Modify Own
+   access (id=3 ) = Basic Access
+user (id=24343444.bh ):
+ name  = Top Sales
+ lastAccess  = 1236700941307
+ firstName  = Top
+ lastName  = Sales
+ roles :
+  role (id=18 ):
+   name  = Participant with Modify Own
+   access (id=3 ) = Basic Access
+user (id=111.ckbs ):
+ name  = Anonymous
+ roles :
+  role (id=11 ):
+   name  = Participant
+   access (id=3 ) = Basic Access
+=end
+