quickbase_client 1.0.8 → 1.0.9

data/README.rdoc

@@ -14,7 +14,7 @@ require 'QuickBaseClient'
 
 qbc = QuickBase::Client.new("quickbase_username","quickbase_password")
 
-qbc.grantedDBs{|db| puts "dbid:#{db.dbinfo.dbid}, dbname:#{db.dbinfo.dbname}" } 
+qbc.grantedDBs{|db| puts "dbid: #{db.dbinfo.dbid}, dbname: #{db.dbinfo.dbname}" } 
 
 
 == Documentation
@@ -29,7 +29,9 @@ More information about the QuickBase Client is available here -
 
 == Change History
 
-1.0.8 - 03/11/2011 Fixed a problem with getApplicationVariables()
+1.0.9 - 03/26/2011 - Added aliases, getCSVForReport(), makeCSVFileForReport(), getCriteriaForQuery().
+
+1.0.8 - 03/11/2011 - Fixed a problem with getApplicationVariables().
 
 1.0.7 - 03/06/2011 - Fixed a problem with formatTimeOfDay().
 

data/lib/QuickBaseClient.rb

@@ -1235,6 +1235,8 @@ class Client
       end
       clistForQuery
    end
+    
+   alias getColumnListForReport getColumnListForQuery
 
    # Returns the slist associated with a query.
    def getSortListForQuery( id, name )
@@ -1249,6 +1251,24 @@ class Client
       end
       slistForQuery
    end
+   
+   alias getSortListForReport getSortListForQuery 
+
+   # Returns the criteria associated with a query.
+   def getCriteriaForQuery( id, name )
+      criteriaForQuery = nil
+      if id
+         query = lookupQuery( id )
+      elsif name
+         query = lookupQueryByName( name )
+      end
+      if query and query.elements["qycrit"]
+         criteriaForQuery = query.elements["qycrit"].text.dup
+      end
+      criteriaForQuery
+   end
+   
+   alias getCriteriaForReport getCriteriaForQuery 
 
    # Returns a valid query operator.
    def verifyQueryOperator( operator, fieldType )
@@ -2011,15 +2031,15 @@ class Client
    def doQuery( dbid, query = nil, qid = nil, qname = nil, clist = nil, slist = nil, fmt = "structured", options = nil  )
 
       @dbid, @clist, @slist, @fmt, @options = dbid, clist, slist, fmt, options
-
-      xmlRequestData = getQueryRequestXML( query, qid, qname )
       
       @clist ||= getColumnListForQuery(qid, qname)
+      @slist ||= getSortListForQuery(qid, qname)
       
-      xmlRequestData << toXML( :clist, @clist ) if clist
-      xmlRequestData << toXML( :slist, @slist ) if slist
-      xmlRequestData << toXML( :fmt, @fmt ) if fmt
-      xmlRequestData << toXML( :options, @options ) if options
+      xmlRequestData = getQueryRequestXML( query, qid, qname )
+      xmlRequestData << toXML( :clist, @clist ) if @clist
+      xmlRequestData << toXML( :slist, @slist ) if @slist
+      xmlRequestData << toXML( :fmt, @fmt ) if @fmt
+      xmlRequestData << toXML( :options, @options ) if @options
 
       sendRequest( :doQuery, xmlRequestData )
 
@@ -2142,6 +2162,9 @@ class Client
    # Uses the active table id. 
    def _downLoadFile( rid, fid, vid = "0" ) downLoadFile( @dbid, rid, fid, vid ) end
 
+   alias downloadFile downLoadFile
+   alias _downloadFile _downLoadFile
+   
    # API_EditRecord
    def editRecord( dbid, rid, fvlist, disprec = nil, fform = nil, ignoreError = nil, update_id = nil, msInUTC =nil )
 
@@ -2275,12 +2298,14 @@ class Client
    def _genAddRecordForm( fvlist = nil ) genAddRecordForm( @dbid, fvlist ) end
 
    # API_GenResultsTable
-   def genResultsTable( dbid, query = nil, clist = nil, slist = nil, jht = nil, jsa = nil, options = nil )
+   def genResultsTable( dbid, query = nil, clist = nil, slist = nil, jht = nil, jsa = nil, options = nil, qid = nil, qname = nil )
 
       @dbid, @query, @clist, @slist, @jht, @jsa, @options = dbid, query, clist, slist, jht, jsa, options
-      @query = "{'0'.CT.''}" if @query.nil?
 
-      xmlRequestData = toXML( :query, @query )
+      @clist ||= getColumnListForQuery(qid, qname)
+      @slist ||= getSortListForQuery(qid, qname)
+
+      xmlRequestData = getQueryRequestXML( query, qid, qname )
       xmlRequestData << toXML( :clist, @clist ) if @clist
       xmlRequestData << toXML( :slist, @slist ) if @slist
       xmlRequestData << toXML( :jht, @jht ) if @jht
@@ -4422,6 +4447,17 @@ class Client
          end
       }
    end
+    
+   # Create a CSV file using the records for a Report.
+   def makeCSVFileForReport(filename,dbid=@dbid,query=nil,qid=nil,qname=nil)
+      csv = getCSVForReport(dbid,query,qid,qname)
+      File.open(filename,"w"){|f|f.write(csv || "")}
+   end
+   
+   # Get the CSV data for a Report.
+   def getCSVForReport(dbid,query=nil,qid=nil,qname=nil)
+      genResultsTable(dbid,query,nil,nil,nil,nil,"csv",qid,qname)
+   end  
 
    # Upload a file into a new record in a table.
    # Additional field values can optionally be set.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quickbase_client
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-03-11 00:00:00.000000000 -08:00
+date: 2011-03-26 00:00:00.000000000 -07:00
 default_executable: 
 dependencies: []
 description: Wraps the QuickBase HTTP API and adds classes and methods to minimize