ipp_quickbase_devkit 0.0.1

data/examples/cookbookfiles/getFieldIDs.rb

@@ -0,0 +1,6 @@
+require 'QuickBaseClient'
+
+puts "\n\nThe field IDs for the QuickBase Community Forum are : #{QuickBase::Client.new.getFieldIDs("8emtadvk").join(",")}\n\n"
+ 
+ 
+ 

data/examples/cookbookfiles/getFieldNames.rb

@@ -0,0 +1,6 @@
+
+require 'QuickBaseClient'
+
+puts "Fields from the QuickBase Community Forum: "
+qbc = QuickBase::Client.new
+puts qbc.getFieldNames("8emtadvk")

data/examples/cookbookfiles/getLastModTime.rb

@@ -0,0 +1,8 @@
+
+require 'QuickBaseClient'
+
+# change "username" "password" to your QuickBase username and password
+qbc = QuickBase::Client.new("username","password")
+qbc.getDBInfo("8emtadvk")
+lastModifiedTimeString = qbc.formatFieldValue(qbc.lastModifiedTime,"timestamp")
+puts "The last thing modified in the QuickBase Community Forum was at #{lastModifiedTimeString} (#{qbc.lastModifiedTime})."

data/examples/cookbookfiles/getLastRecModTime.rb

@@ -0,0 +1,8 @@
+
+require 'QuickBaseClient'
+
+# change "username" "password" to your QuickBase username and password
+qbc = QuickBase::Client.new("username","password")
+qbc.getDBInfo("8emtadvk")
+lastRecModTimeString = qbc.formatFieldValue(qbc.lastRecModTime,"timestamp")
+puts "A record was last modified in the QuickBase Community Forum at #{lastRecModTimeString} (#{qbc.lastRecModTime})."

data/examples/cookbookfiles/getNumRecords.rb

@@ -0,0 +1,8 @@
+
+require 'QuickBaseClient'
+
+# change "username" "password" to your QuickBase username and password
+qbc =  QuickBase::Client.new("username","password")
+numRecords = qbc.getNumRecords("8emtadvk")
+puts "There are #{numRecords} in the QuickBase Community Forum database"
+

data/examples/cookbookfiles/getNumTables.rb

@@ -0,0 +1,4 @@
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new
+puts "There are #{qbc.getNumTables("bbtt9cjr6")} tables in the QuickBase Application Library."

data/examples/cookbookfiles/getRecord.rb

@@ -0,0 +1,5 @@
+require 'QuickBaseClient'
+qbc = QuickBase::Client.new
+qbc.getRecord("24105","8emtadvk"){|myRecord| 
+  myRecord.each{|key,value| puts "Field: #{key}, Value: #{value}\n" }
+}

data/examples/cookbookfiles/getRecordDisplayURL.rb

@@ -0,0 +1,13 @@
+
+require 'QuickBaseMisc'
+
+r = QuickBase::Misc.decimalToBase32(24105)
+puts "<a href=\"https://www.quickbase.com/db/8emtadvk?a=dr&r=#{r}\">Ruby API home page</a>"
+
+=begin
+
+The above code prints this HTML link -
+
+<a href="https://www.quickbase.com/db/8emtadvk?a=dr&r=ztj">Ruby API home page</a>
+
+=end

data/examples/cookbookfiles/getRecordsAddedToday.rb

@@ -0,0 +1,20 @@
+
+require 'QuickBaseClient'
+require 'Date'
+
+# change "username" "password" to your QuickBase username and password
+qbc =  QuickBase::Client.new("username","password")
+
+today = Date.today
+today = today.strftime("%m-%d-%Y")
+communityForumRecords = qbc.getAllValuesForFields("8emtadvk",["Subject","Message"],"{'1'.EX.'#{today}'}",nil,nil,"6.10")
+
+puts "\n --- QuickBase Community Forum Records added today ---\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/getRecordsAsJSON.rb

@@ -0,0 +1,6 @@
+require "QuickBaseClient"
+
+# print the list of QuickBase formula functions in JSON format:
+
+qbc=QuickBase::Client.new(ENV["quickbase_username"],ENV["quickbase_password"])
+puts qbc.getAllValuesForFieldsAsPrettyJSON("6ewwzuuj",["Function Name"])

data/examples/cookbookfiles/getReportNames.rb

@@ -0,0 +1,25 @@
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new
+
+# list the reports from the Formula Functions Reference table in the QuickBase Support Center
+puts qbc.getReportNames("6ewwzuuj")
+
+=begin
+
+The above code prints the list below:-
+
+All Functions
+All Functions and Operators
+Boolean Functions
+Formula Export View
+gsa_formula functions ref
+List All
+List Changes
+Number Functions
+Operators - Binary
+Operators - Unary
+Text Functions
+Time and Date Functions
+
+=end

data/examples/cookbookfiles/getRoleInfo.rb

@@ -0,0 +1,48 @@
+
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new
+
+puts "\nRoles in the QuickBase Community Forum\n\n"
+
+qbc.getRoleInfo("bbqm84dzy") { |role|
+  puts "id: #{role.attributes['id']}"
+  puts "name: #{role.elements['name'].text}"
+  puts "access id: #{role.elements['access'].attributes['id']}"
+  puts "access name: #{role.elements['access'].text}"
+  puts "============================="
+}
+
+=begin
+
+Output of the above script:
+
+Roles in the QuickBase Community Forum
+
+id: 10
+name: Viewer
+access id: 3
+access name: Basic Access
+=============================
+id: 11
+name: Participant
+access id: 3
+access name: Basic Access
+=============================
+id: 12
+name: Administrator
+access id: 1
+access name: Administrator
+=============================
+id: 17
+name: Product Manager
+access id: 1
+access name: Administrator
+=============================
+id: 18
+name: Participant with Modify Own
+access id: 3
+access name: Basic Access
+=============================
+
+=end

data/examples/cookbookfiles/getServerStatus.rb

@@ -0,0 +1,11 @@
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new
+serverStatus = qbc.getServerStatus
+
+puts "\nversion: #{serverStatus['version']}"
+puts "users:     #{serverStatus['users']}"
+puts "groups:    #{serverStatus['groups']}"
+puts "databases: #{serverStatus['databases']}"
+puts "uptime:    #{serverStatus['uptime']}"
+puts "updays:    #{serverStatus['updays']}"

data/examples/cookbookfiles/getSortListForReport.rb

@@ -0,0 +1,6 @@
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new
+qbc.getSchema("8emtadvk")
+puts "Sort fields for QuickBase Community Forum 'List Changes' report: #{qbc.getSortListForQuery(nil,'List Changes')}"
+puts "Sort fields for QuickBase Community Forum 'List Changes' report: #{qbc.getSortListForQuery('2',nil)}"

data/examples/cookbookfiles/getTableIDs.rb

@@ -0,0 +1,6 @@
+require 'QuickBaseClient'
+
+puts "\nThe QuickBase Support Center has these child tables:\n\n"
+puts QuickBase::Client.new.getTableIDs("9kaw8phg").join("\n")
+
+

data/examples/cookbookfiles/getTableName.rb

@@ -0,0 +1,8 @@
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new
+
+puts "The name of the table for dbid 'bbqm84dzy' is '#{qbc.getTableName('bbqm84dzy')}'."
+
+# The above code prints  - 
+# The name of the table for dbid 'bbqm84dzy' is 'QuickBase Community Forum'.

data/examples/cookbookfiles/getTableNames.rb

@@ -0,0 +1,25 @@
+
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new
+tableNames = qbc.getTableNames("bbtt9cjr6")
+puts "\nTables in the QuickBase Application Library:\n\n"
+puts tableNames.join( "\n")
+
+=begin
+Output of the above script:
+
+Tables in the QuickBase Application Library:
+
+Applications
+Versions
+Files
+Reviews
+Activity Log
+Bookmarks
+Feedback
+Featured Apps
+Categories
+
+=end
+

data/examples/cookbookfiles/getTimeCreated.rb

@@ -0,0 +1,8 @@
+
+require 'QuickBaseClient'
+
+# change "username" "password" to your QuickBase username and password
+qbc = QuickBase::Client.new("username","password")
+qbc.getDBInfo("8emtadvk")
+createdTimeString = qbc.formatFieldValue(qbc.createdTime,"timestamp")
+puts "The QuickBase Community Forum was created #{createdTimeString} (#{qbc.createdTime})."

data/examples/cookbookfiles/getTimeInMilliseconds.rb

@@ -0,0 +1,5 @@
+require 'QuickBaseMisc'
+
+puts "\n\nThe time now in milliseconds is #{QuickBase::Misc.time_in_milliseconds}."
+puts "\nThe time in milliseconds at the beginning of today was #{QuickBase::Misc.time_in_milliseconds(Date.today)}."
+puts "\nThe time in milliseconds at this time tomorrow will be #{QuickBase::Misc.time_in_milliseconds(DateTime.now + 1)}."

data/examples/cookbookfiles/getUserInfo.rb

@@ -0,0 +1,26 @@
+
+require 'QuickBaseClient'
+
+def displayUserInfo( qbc, emailAddress = nil)
+  
+  qbc.getUserInfo emailAddress
+
+  puts "name        : #{qbc.name}"
+  puts "first name  : #{qbc.firstName}"
+  puts "last name   : #{qbc.lastName}"
+  puts "login       : #{qbc.login}"
+  puts "email       : #{qbc.email}"
+  puts "screen name : #{qbc.screenName}"
+  puts "externalAuth: #{qbc.externalAuth}"
+  puts "user id     : #{qbc.userid}"
+
+end
+
+
+qbc = QuickBase::Client.new("username","password")
+
+puts "\n\nInformation in QuickBase about the person running this script:\n\n"
+displayUserInfo(qbc)
+
+puts "\n\nInformation in QuickBase about fred_flinstone@internet.com:\n\n"
+displayUserInfo(qbc, "fred_flinstone@internet.com")

data/examples/cookbookfiles/getUserRole.rb

@@ -0,0 +1,15 @@
+
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new("username","password")
+
+qbc.getUserInfo( "fred_flinstone@internet.com")
+
+qbc.getUserRole("bbqm84dzy",qbc.userid)
+
+puts "user id  : #{qbc.userid}"
+puts "user name: #{qbc.username}"
+puts "role id  : #{qbc.roleid}"
+puts "role name: #{qbc.rolename}"
+puts "access id: #{qbc.accessid}"
+puts "access   : #{qbc.access}"

data/examples/cookbookfiles/intranet.rb

@@ -0,0 +1,101 @@
+
+require 'rubygems'
+require 'ramaze'
+require 'QuickBaseClient'
+require 'cgi'
+
+#-----------------------------------------------------------  
+class MainController < Ramaze::Controller
+
+  map '/'
+  layout :page
+   
+  #-----------------------------------------------------------  
+  def index
+      @title = "Intranet"
+      html =   "<form method=\"post\" action=\"/listQuickBaseApplications\">"
+      html << "<p>User name:<input type=\"text\" name=\"username\"></input></p>" 
+      html << "<p>Password :<input type=\"text\" name=\"password\"></input></p>"
+      html << "<input type=\"submit\" name=\"my_quickbase\" value=\"My QuickBase.\">"     
+      html << "</form>"     
+   end  
+  
+  #-----------------------------------------------------------  
+  def listQuickBaseApplications
+     @title = "My QuickBase"
+     if request['username'] and request['password']
+      @qbc = QuickBase::Client.new(request['username'], request['password']) 
+      if @qbc and @qbc.requestSucceeded
+         html = ""
+         grantedDBname = ""
+         grantedDBid = ""
+         dbproc = proc { |element|
+            if element.is_a?(REXML::Element)
+               if element.has_text? 
+                  if element.name == "dbname"
+                    grantedDBname = element.text
+                  elsif element.name == "dbid"
+                    grantedDBid = element.text
+                  end  
+               end
+            end
+         }
+         @qbc.grantedDBs("1","1","1"){|grantedDB|
+             @qbc.processChildElements(grantedDB,true,dbproc)
+             html << "<br>(<a href=\"/showSchema/#{CGI.escape(request['username'])}/#{CGI.escape(request['password'])}/#{grantedDBid}/#{CGI.escape(grantedDBname)}\">schema</a>) <a href=\"https://www.quickbase.com/db/#{grantedDBid}\">#{grantedDBname}</a>" 
+         }         
+         html
+      else
+       "<p><b>Oops - something went wrong while connecting to QuickBase.<br>Please check your username and password.</b></p>"
+      end    
+     else
+       "<p><b>Oops - please specifiy your QuickBase username and password.</b></p>"
+     end  
+  end     
+
+  #-----------------------------------------------------------  
+  def showSchema(username,password,dbid,dbname)
+     @title = "Schema for #{dbname}"
+      html = "Oops - couldn't find the schema for that table."
+      @qbc = QuickBase::Client.new(username,password)
+      if @qbc and @qbc.requestSucceeded
+         @qbc.getSchema(dbid)
+         if @qbc.requestSucceeded
+           schema = ""
+           
+           # if you get 'undefined variable transitive' from the next line
+           # edit rexml\document.rb and change 'trans=false' to ''transitive=false'
+           @qbc.qdbapi.write(schema, 3)
+           
+           schema.gsub!("<","&lt;")
+           schema.gsub!(">","&gt;")
+           html = "<pre>#{schema}</pre>" 
+         end
+       end   
+      html 
+    end
+    
+  #-----------------------------------------------------------  
+  def error
+      "<p><b>Sorry - that is not a valid web page on this web site.</b></p>"
+  end  
+
+  #-----------------------------------------------------------  
+   def page
+    %{
+<html>
+  <head>
+    <title>#@title</title>
+  </head>
+  <body>
+    <h2>#@title</h2><a href ="/index">Home</a> 
+    <hr>
+    #@content
+  </body>
+</html>
+    }
+  end
+ end
+ 
+ Ramaze.start
+ 

data/examples/cookbookfiles/isAverageField.rb

@@ -0,0 +1,17 @@
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new
+
+qbc.getSchema("93htvp8y")
+
+if qbc.isAverageField?("Subject")
+    puts "The 'Subject' field in the QuickBase Community Forum has an Average at the bottom of reports."
+else
+    puts "The 'Subject' field in the QuickBase Community Forum does not have a Average at the bottom of reports."
+end
+
+if qbc.isAverageField?("# of Posts")
+    puts "The '# of Posts' field in the QuickBase Community Forum has a Average at the bottom of reports."
+else
+    puts "The '# of Posts' field in the QuickBase Community Forum does not have a Average at the bottom of reports."
+end

data/examples/cookbookfiles/isDbidString.rb

@@ -0,0 +1,8 @@
+
+require 'QuickBaseMisc'
+
+print "\n\nEnter a string: "
+string = gets.chop
+
+puts "\n\n'#{string}' is #{QuickBase::Misc.isDbidString?(string) ? '' : 'not'} a valid QuickBase table id string.\n\n"
+

data/examples/cookbookfiles/isTotalField.rb

@@ -0,0 +1,16 @@
+require 'QuickBaseClient'
+
+qbc = QuickBase::Client.new
+
+qbc.getSchema("8emtadvk")
+if qbc.isTotalField?("Subject")
+    puts "The 'Subject' field in the QuickBase Community Forum has a Total at the bottom of reports."
+else
+    puts "The 'Subject' field in the QuickBase Community Forum does not have a Total at the bottom of reports."
+end
+
+if qbc.isTotalField?("# of Posts")
+    puts "The '# of Posts' field in the QuickBase Community Forum has a Total at the bottom of reports."
+else
+    puts "The '# of Posts' field in the QuickBase Community Forum does not have a Total at the bottom of reports."
+end