ipp_quickbase_devkit 0.0.1

data/lib/runOfflineFieldEntryDialog.rb

@@ -0,0 +1,203 @@
+#--#####################################################################
+# Copyright (c) 2009 Gareth Lewis and Intuit, Inc.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# which accompanies this distribution, and is available at
+# http://www.opensource.org/licenses/eclipse-1.0.php
+#
+# Contributors:
+#    Gareth Lewis - Initial contribution.
+#    Intuit Partner Platform.
+#++#####################################################################
+
+require 'QuickBaseTextData'
+require 'tk'
+
+# Display a dialog with one text entry field, and buttons to send the text to a 
+# field in a new record in QuickBase, go to QuickBase, and to close the dialog.
+# * 'dbid' must be a valid table id. 
+# * 'field' must be the name or id of a text field in the 'dbid' table.
+# If you can't connect to QuickBase, data will be written to a file in your
+# current working directory then sent to QuickBase next time you are
+# able to connect. Note that you must have connected to QuickBase at least
+# once before you can enter data offline.
+def runOfflineFieldEntryDialog(username,password,dbid,field)
+      
+   connected = false
+   appendToOfflineFile = false
+   
+   numTextLines = 1
+   tableName = ""
+   fieldID = "" 
+   fieldName = ""
+   
+   offlineDataFileName = "#{dbid}.offline.txt"
+   offlineConfigFileName = "#{dbid}.offline.cfg"
+      
+   if FileTest.exist?(offlineConfigFileName)
+      File.open(offlineConfigFileName,"r"){|f| 
+         cfg = f.gets
+         tableName, numTextLines, fieldID, fieldName = cfg.split(":::")
+         numTextLines = numTextLines.to_i
+      }
+   end
+      
+   @qbc = QuickBase::Client.new(username,password)
+   if @qbc and @qbc.requestSucceeded
+      connected = true
+      if FileTest.exist?(offlineDataFileName)
+         QuickBase::TextData.uploadData(username,password,offlineDataFileName)
+         File.delete(offlineDataFileName)
+      end
+   else
+      appendToOfflineFile = true if FileTest.exist?(offlineDataFileName)
+   end   
+      
+   @offlineDataFile = nil
+   if connected
+      @qbc.getSchema(dbid)
+      if @qbc.requestSucceeded
+         field = field.join(' ')
+         field.strip!
+         fieldID = @qbc.lookupFieldIDByName(field)
+         if fieldID
+            fieldName = field
+         else
+            fieldName = lookupFieldNameFromID(field)
+            fieldID = field if fieldName
+         end
+         tableName = @qbc.getResponseElement( "table/name" ).text
+         if fieldID and fieldName
+            fieldElement = @qbc.lookupField(fieldID)
+            numLinesProc = proc { |element|
+               if element.is_a?(REXML::Element) and element.name == "num_lines" and element.has_text?
+                  numTextLines = element.text.to_i
+               end
+            }
+            @qbc.processChildElements(fieldElement, true, numLinesProc)
+            File.open(offlineConfigFileName,"w"){|f|f.write("#{tableName}:::#{numTextLines}:::#{fieldID}:::#{fieldName}")}
+         else
+            Tk.messageBox({"icon"=>"error","title"=>"Oops!", "message" => "Error finding the QuickBase field '#{fieldName}' in the '#{tableName}' table."})      
+         end
+      else
+         Tk.messageBox({"icon"=>"error","title"=>"Oops!", "message" => "Error finding the QuickBase table with the '#{dbid}' id."})      
+      end
+   elsif appendToOfflineFile
+      @offlineDataFile = File.open(offlineDataFileName, "a")
+   else   
+      @offlineDataFile = File.open(offlineDataFileName, "w")
+      @offlineDataFile.puts("dbid:#{dbid}")
+   end
+            
+   root = TkRoot.new{ title tableName }
+   frame = TkFrame.new(root){
+       borderwidth 4 
+       width 60
+       pack "side" => "top"
+   }
+   if numTextLines == 1
+      labelText = "Enter '#{fieldName}' and press Enter or click 'Send to QuickBase':"
+   else
+      labelText = "Enter '#{fieldName}' and click 'Send to QuickBase':"
+   end
+   fieldLabel = TkLabel.new(frame){
+       text labelText
+       font "Arial 10 bold"
+       pack "side"=>"top", "expand" => true 
+   }
+   
+   entryField = nil
+   if numTextLines == 1
+      entryField = TkEntry.new(frame){
+          font "Arial 10 bold"
+          pack "fill" => "x", "expand" => true, "side" => "top",  "padx" =>5, "pady"=>5  
+      }
+      entryField.bind('Key-Return') {|e|  
+         value = entryField.get
+         if connected
+            @qbc.clearFieldValuePairList
+            @qbc.addFieldValuePair(nil,fieldID,nil,value)
+            @qbc.addRecord(dbid,@qbc.fvlist)
+         else
+            @offlineDataFile.puts("record:\n#{fieldName}:#{value}")
+         end
+         entryField.value = ""
+      }
+   elsif numTextLines > 1
+      entryField = TkText.new(frame){
+          height numTextLines
+          width 60
+          font "Arial 10 bold"
+          pack "fill" => "both", "expand" => true, "side" => "top",  "padx" =>5, "pady"=>5  
+          wrap "word"
+      }
+   end
+   entryField.focus
+   
+   buttonFrame = TkFrame.new(frame){
+       pack "side" => "bottom"
+       width 50 
+   }
+   sendButton = TkButton.new(buttonFrame){
+       text "Send To QuickBase" 
+       underline 0
+       font "Arial 10 bold"
+       pack "side"=>"left", "padx"=>5, "pady"=>5
+   }
+   sendButton.command {
+      if numTextLines > 1
+         value = entryField.get("1.0","end")
+      else
+         value = entryField.get
+      end
+      if connected
+         @qbc.clearFieldValuePairList
+         @qbc.addFieldValuePair(nil,fieldID,nil,value)
+         @qbc.addRecord(dbid,@qbc.fvlist)
+      else
+         @offlineDataFile.puts("record:\n#{fieldName}:#{value}")
+      end
+      entryField.value = ""
+   }
+    
+   if connected
+      launchButton = TkButton.new(buttonFrame){
+          text "Go to QuickBase..." 
+          underline 0
+          font "Arial 10 bold"
+          pack "side"=>"left","padx"=>5, "pady"=>5
+      }
+      launchButton.command {
+         url = "http://www.quickbase.com/db/#{dbid}"
+         url = "start #{url}" if RUBY_PLATFORM.split("-")[1].include?("mswin")  
+         system(url)
+      }
+   end
+   closeButton = TkButton.new(buttonFrame){
+       text "Close" 
+       underline 0
+       font "Arial 10 bold"
+       pack "side"=>"right","padx"=>5, "pady"=>5
+   }
+   closeButton.command { Tk.exit }
+   
+   root.bind('Alt-KeyRelease-s') {|e| sendButton.invoke }
+   root.bind('Alt-KeyRelease-l') {|e| launchButton.invoke }
+   root.bind('Alt-KeyRelease-c') {|e| closeButton.invoke }
+
+   Tk.mainloop
+end
+
+if ARGV[3]
+   runOfflineFieldEntryDialog(ARGV[0],ARGV[1],ARGV[2],ARGV[3..-1])
+else
+   puts "\nusage: ruby runOfflineFieldEntryDialog.rb username password dbid field"
+   puts "\n'dbid' must be a valid table id." 
+   puts "'field' must be the name or id of a text field in the 'dbid' table."
+   puts "'field' can be more than one word, e.g. 'To-Do Item'."
+   puts "If you can't connect to QuickBase, data will be written to a file in"
+   puts "your current working directory then sent to QuickBase next time you"
+   puts "are able to connect. Note that you must have connected to QuickBase"
+   puts "at least once before you can enter data offline.\n"
+end

data/rakefile

@@ -0,0 +1,100 @@
+
+require 'rake'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+
+spec = Gem::Specification.new do |s|
+   s.rubyforge_project = "orphans" # prevents WARNING
+   
+   if RUBY_PLATFORM == "java" # jruby
+      s.name    = "ipp_quickbase_devkit_jruby" # saves people having to download additional jruby-specific gems 
+      s.description = "The ipp_quickbase_devkit_jruby wraps the QuickBase HTTP API and adds a lot of classes and methods to minimize the amount of code need to get useful things done."
+      s.add_dependency("json-jruby")
+      s.add_dependency("jruby-openssl")
+      s.rdoc_options = ["--line-numbers", "--inline-source", "--main", "README.rdoc", "--title", "ipp_quickbase_devkit_jruby: JRuby client for database applications on www.quickbase.com and workplace.intuit.com"]
+      s.post_install_message = %q{**************************************************
+
+  Thank you for installing ipp_quickbase_devkit_jruby.
+  Distributed under the Eclipse Public License Version 1.0.
+
+**************************************************
+}
+   else
+      s.name    = "ipp_quickbase_devkit"
+      s.description = "The ipp_quickbase_devkit wraps the QuickBase HTTP API and adds a lot of classes and methods to minimize the amount of code need to get useful things done."
+      s.add_dependency("json") if RUBY_VERSION.include?("1.8.")
+      s.rdoc_options = ["--line-numbers", "--inline-source", "--main", "README.rdoc", "--title", "ipp_quickbase_devkit: Ruby client for database applications on www.quickbase.com and workplace.intuit.com"]
+      s.post_install_message = %q{**************************************************
+
+  Thank you for installing ipp_quickbase_devkit.
+  Distributed under the Eclipse Public License Version 1.0.
+
+**************************************************
+}
+
+   end   
+   s.version  = "0.0.1"
+   s.date     =  "2009-07-01"
+   s.authors = ["Gareth Lewis"]
+   s.email = "dev-ipp_dev_kits@code.intuit.com"
+   s.summary = "The ipp_quickbase_devkit is a Ruby wrapper for the QuickBase HTTP API."
+   s.homepage = "https://code.intuit.com/sf/projects/ipp_dev_kits"
+   s.has_rdoc = true
+   s.extra_rdoc_files = ["LICENSE","README.rdoc"]
+   s.require_paths = ["lib"]
+   s.add_dependency("rspec", [">= 1.2.7"])
+   s.add_development_dependency("rspec", [">= 1.2.7"])
+   s.required_ruby_version = ">=1.8.6"
+   s.platform = Gem::Platform::RUBY
+   s.files = FileList["LICENSE","README.rdoc","rakefile","examples/**/*.","examples/**/*.*","doc/*.*","lib/*.rb","lib/*.qbc","test/*.rb","test/*.bat"].exclude(".svn").to_a
+end 
+
+Rake::GemPackageTask.new(spec).define
+
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['spec_all_tests.rb']
+  t.ruby_opts = ['-C test']
+end
+
+desc 'Uninstall dev gem'
+task :uninstall_gem do
+  if RUBY_PLATFORM == "java"
+	   sh 'jruby -S gem uninstall ipp_quickbase_devkit_jruby'
+  else    
+	   sh 'gem uninstall ipp_quickbase_devkit'
+  end   
+end
+
+desc 'Build dev gem'
+task :build_gem do
+	Rake::Task[:repackage].invoke
+end
+
+desc 'Install dev gem'
+task :install_gem do
+   if RUBY_PLATFORM == "java"
+	    sh 'jruby -S gem install pkg/ipp_quickbase_devkit_jruby'
+   else   
+	    sh 'gem install pkg/ipp_quickbase_devkit'
+   end   
+end
+
+desc '(Default task) Uninstalls, rebuilds & installs gem from source'
+task :full_rebuild do
+	Rake::Task[:uninstall_gem].invoke
+	Rake::Task[:repackage].invoke
+	Rake::Task[:install_gem].invoke
+end
+
+desc 'Full rebuild, then run tests'
+task :full_rebuild_and_test do
+	Rake::Task[:full_rebuild].invoke
+	puts "**************************************************"
+	puts ""
+	puts "             Running unit tests"
+	puts ""
+	puts "**************************************************"
+	Rake::Task[:spec].invoke	
+end
+
+task :default => :full_rebuild

data/test/run_tests.bat

@@ -0,0 +1,7 @@
+@echo off
+
+set RUBYLIB=
+
+call spec spec_all_tests.rb > testresults.txt
+
+REM pause

data/test/spec_all_tests.rb

@@ -0,0 +1,13 @@
+
+
+def ruby19?
+  RUBY_VERSION >= "1.9"
+end
+
+require 'rubygems'
+require 'spec_smoke_tests'
+require 'spec_workplace_smoke_tests'
+require 'spec_workplace_objects_test'
+require 'spec_workplace_addrecord_test'
+require 'spec_workplace_editrecord_test'
+require 'spec_workplace_json_test'

data/test/spec_smoke_tests.rb

@@ -0,0 +1,58 @@
+
+require 'spec'
+
+describe "Smoke Test" do
+
+  it "should show that the basic ruby files are in the regular ruby paths" do
+      found = false
+      $:.each{|path| found = true if File.exist?("#{path}/date.rb") }
+      found.should == true
+  end  
+
+  it "should show that the main ipp_quickbase_devkit src file is not in the regular ruby paths" do
+      found = false
+      $:.each{|path| found = true if File.exist?("#{path}/QuickBaseClient.rb") } unless ruby19?
+      found.should == false
+  end  
+
+  it "should show that the main ipp_quickbase_devkit src file is not loaded by default" do
+      found = false
+      $".each{|path| found = true if path.include? "QuickBaseClient.rb" }
+      found.should == false
+  end  
+  
+  it "should find ipp_quickbase_devkit" do
+    found = require 'QuickBaseClient'
+    found.should == true
+  end
+  
+  it "should create a QuickBase::Client" do
+    qbc_required = require 'QuickBaseClient'
+    qbc =  QuickBase::Client.new
+    qbc.should_not == nil
+  end
+  
+  it "should create a QuickBase::CommandLineClient" do
+    require 'QuickBaseCommandLineClient'
+    qbc =  QuickBase::CommandLineClient.new
+    qbc.should_not == nil
+  end
+  
+  it "should create a QuickBase::WebClient" do
+    require 'QuickBaseWebClient'
+    qbc =  QuickBase::WebClient.new(false)
+    qbc.should_not == nil
+  end
+
+  it "should show that the gem searching is turned on" do
+      gemSearching = ENV["RUBYOPT"].include? "-rubygems"
+      gemSearching.should == true
+  end  
+
+  it "should NOT find ipp_quickbase_devkit when -rubygems option is off" do
+    ENV["RUBYOPT"]=""
+    found = require 'QuickBaseClient'
+    found.should == false
+  end
+
+end

data/test/spec_workplace_addrecord_test.rb

@@ -0,0 +1,46 @@
+
+require 'spec_workplace_base_test'
+require 'spec'
+
+describe "Workplace Add Record test" do
+  
+  it "should add a Person" do
+    
+    require 'WorkPlaceClient'
+    class WorkPlaceAddRecordTest
+       include WorkPlaceBaseTest
+    end  
+    wpart = WorkPlaceAddRecordTest.new 
+    workPlaceClient = wpart.setup
+    workPlaceClient.should_not == nil
+    
+    personFieldValues = Hash["First Name", "FirstName", "Last Name", "LastName", "Email", "FirstNameLastName@email.com","Web Page","http://www.FirstNameLastName.com","Opt In","1","DOB","12-12-1978","Attention Span","1","Favorite Number","7","Amount Owed", "34.87","Rating", "4","PhoneNumber", "454-323-3456","Bedtime", "23","Address", "10 Downing Street"]
+    workPlaceClient.setFieldValues(personFieldValues)
+    rid, update_id = workPlaceClient.addRecord(wpart.personTableDBID,workPlaceClient.fvlist)
+    rid.should_not == nil
+    
+  end
+
+  it "should add a Person with an Image file attachment" do
+    
+    require 'WorkPlaceClient'
+    class WorkPlaceAddRecordTest
+       include WorkPlaceBaseTest
+    end  
+    wpart = WorkPlaceAddRecordTest.new 
+    workPlaceClient = wpart.setup
+    workPlaceClient.should_not == nil
+    
+    workPlaceClient.addFieldValuePair("First Name",nil,nil,"Whatever")
+    workPlaceClient.addFieldValuePair("Last Name",nil,nil,"Works")
+    workPlaceClient.addFieldValuePair("Image",nil,"FileName","File Contents") # contents from memory 
+    rid, update_id = workPlaceClient.addRecord(wpart.personTableDBID,workPlaceClient.fvlist)
+    rid.should_not == nil
+    
+    fid = workPlaceClient.lookupFieldIDByName("Image", wpart.personTableDBID)
+    response, filecontents = workPlaceClient._downLoadFile(rid,fid)
+    filecontents.should == "File Contents"
+    
+  end
+
+end

data/test/spec_workplace_base_test.rb

@@ -0,0 +1,57 @@
+
+module WorkPlaceBaseTest
+
+  attr_reader :workPlaceClient, :testAppDBID, :testAppName, :personTableDBID, :personFields 
+
+  def setup
+
+    if not File.exist?("test.config")
+      File.open("test.config","w"){|f|
+         f.puts("username:<enter your workplace username>")
+         f.puts("password:<enter your workplace password>")
+         f.puts("appname:<enter the name of an existing test application, e.g. MyTestApp>")
+         f.puts("apptoken:<enter a valid application token for your test application>")
+         raise "***Please fill out the fields in test.config***"
+      }
+    end  
+
+    @options = {}
+    #@options["printRequestsAndResponses"]=true
+    @options["stopOnError"]=true
+    IO.foreach("test.config"){|line|
+      key,value = line.split(/:/)
+      @options[key]=value.strip if key and value
+    }
+    
+    raise "'username' missing from test.config" if !@options["username"]
+    raise "'password' missing from test.config" if !@options["password"]
+    raise "'appname' missing from test.config"  if !@options["appname"]
+    raise "'apptoken' missing from test.config" if !@options["apptoken"]
+    
+    @workPlaceClient = QuickBase::WorkPlaceClient.init(@options)
+    
+    #@workPlaceClient.printRequestsAndResponses=true
+    
+    @workPlaceClient.grantedDBs().each{|dbinfo| @testAppDBID = dbinfo.dbid if dbinfo.dbname == @options["appname"] }
+    
+    @testAppName = "Test copy of #{@options['appname']}"
+    @workPlaceClient.grantedDBs().each{|dbinfo| @workPlaceClient.deleteDatabase(dbinfo.dbid) if dbinfo.dbname == @testAppName }
+    @testAppDBID = @workPlaceClient.cloneDatabase(@testAppDBID, @testAppName, @testAppName, true) if @testAppDBID
+    
+    @testAppName = @options['appname'] unless @testAppDBID
+    @testAppDBID = @workPlaceClient.createDatabase(@options["appname"],@options["appname"]) unless @testAppDBID
+    
+    raise "Unable to clone or create an application with the name #{@options['appname']}" unless @testAppDBID
+    
+    @personsTableName = "Persons"
+    @personTableDBID = @workPlaceClient.createTable(@personsTableName, @testAppDBID)
+    @personFields = Hash["First Name", "text", "Last Name", "text", "Email", "email","Image","file","Web Page","url","Opt In","checkbox","DOB","date","Attention Span","duration","Favorite Number","float","Favorite Number Squared","float","Amount Owed", "currency","Rating", "rating","PhoneNumber", "phone","Bedtime", "timeofday","Address", "text"]
+    @personFields.each{|name,type|
+      fid,label = @workPlaceClient.addField(@personTableDBID,name,type)
+      @workPlaceClient.setFieldProperties(@personTableDBID,{"formula" => "[Favorite Number] * [Favorite Number]"},fid) if name == "Favorite Number Squared"
+      @workPlaceClient.setFieldProperties(@personTableDBID,{"num_lines" => "3"},fid) if name == "Address"
+    }
+    @workPlaceClient
+  end  
+  
+end