ipp_quickbase_devkit 0.0.1

data/examples/pmp/app/views/projects/all_projects.rhtml

@@ -0,0 +1,33 @@
+<h1>All Projects</h1>
+
+This View shows how to display records using the names of QuickBase queries and fields.
+<p>
+Queries defined in the QuickBase UI (i.e. 'Table' Reports) include filtering and sorting criteria and the list of columns to display. 
+The list of @projects is retrieved from QuickBase using <i>find_by_sql("All Projects")</i> in the <i>projects.rb</i> model class.
+The list of fields in the QuickBase 'All Projects' report is retrieved using <i>reportFields = connection.raw_connection.clist.split('.')</i>
+in the <i>projects.rb</i> model class, and controls the list of columns displayed below using <i>column.quickBaseFieldAttributes["quickBaseFieldId"]</i>.
+<p>
+See the <i>QuickBaseColumn</i> class in quickbase_adapter.rb to understand how this works.
+<hr>
+
+<table border="1">
+
+   <tr>
+   <% Projects.columns.each { |column| %>
+      <% if @reportColumns.include?(column.quickBaseFieldAttributes["quickBaseFieldId"]) %>
+         <td><b><%= column.human_name %></b></td>
+      <% end %>
+   <% } %>
+   </tr>
+   
+   <% for project in @projects do %>
+      <tr>
+         <% Projects.columns.each { |column| %>
+            <% if @reportColumns.include?(column.quickBaseFieldAttributes["quickBaseFieldId"]) %>
+               <td><%= project[column.human_name] %></td>
+            <% end %>
+         <% } %>
+      </tr>   
+   <% end %>
+
+</table>

data/examples/pmp/app/views/projects/home.rhtml

@@ -0,0 +1,11 @@
+
+<b>
+Click on the links on the left to see different ways to retrieve records from QuickBase.
+<p>
+You can retrieve records using ActiveRecord 'find' calls, hard-coded SQL SELECT statements, 
+QuickBase Reports, and queries written in the QuickBase query language.
+<p>
+You can also retrieve data from any QuickBase table you have access to, even if it's not in 
+the QuickBase application associated with your Rails application.
+
+</b>

data/examples/pmp/app/views/projects/my_open_projects.rhtml

@@ -0,0 +1,27 @@
+<h1>My Open Projects</h1>
+
+This View shows how to display records using a QuickBase query and Rails methods to retrieve column
+ data.  Note that column names that contain spaces must be accessed using a string.  If you don't see any 
+ records listed below, add a Projects record in QuickBase and make yourself the Project Lead.
+
+<hr>
+
+<table border="1">
+
+   <tr>
+      <td><b>Name</b></td>
+      <td><b>Priority</b></td>
+      <td><b>Status</b></td>
+      <td><b>Percent Complete</b></td>
+   </tr>
+   
+   <% for project in @projects do %>
+      <tr>
+         <td><%= project.attributes["Project Name"] %></td>
+         <td><%= project.Priority %></td>
+         <td><%= project.Status %></td>
+         <td><%= project["Percent Complete"] %></td>
+      </tr>   
+   <% end %>
+
+</table>

data/examples/pmp/app/views/projects/open_projects.rhtml

@@ -0,0 +1,44 @@
+<h1>Open Projects</h1>
+
+This View shows how to display records using a QuickBase query and Rails methods to retrieve column
+ data.  Note that column names that contain spaces must be accessed using a string.
+ <p>
+ This view also shows the counts of Projects by status in the form of sentences. 
+ This is a basic example of something that is impossible to do within the regular QuickBase UI.  
+
+<hr>
+
+<% statusCount = {}  %>
+
+<table border="1">
+
+   <tr>
+         <td><b>Name</b></td>
+         <td><b>Priority</b></td>
+         <td><b>Status</b></td>
+         <td><b>Estimated Project Start Date</b></td>
+         <td><b>Planned Finish Date</b></td>
+   </tr>
+   
+   <% for project in @projects do %>
+      <tr>
+               <td><%= project.attributes["Project Name"] %></td>
+               <td><%= project.Priority %></td>
+               <td><%= project.Status %></td>
+               <% statusCount[project.Status] ||= 0 %>
+               <% statusCount[project.Status] += 1 %>
+               <td><%= project["Estimated Project Start Date"] %></td>
+               <td><%= project["Planned Finish Date"] %></td>
+      </tr>   
+   <% end %>
+
+</table>
+
+<hr>
+
+<b>
+<% statusCount.each{|key,value| %>
+   <p>The number of <%= key %> projects is <%= value %>. 
+<% } %>
+</b>
+

data/examples/pmp/app/views/projects/project_sorted_by_company.rhtml

@@ -0,0 +1,40 @@
+<h1>Project sorted by Company</h1>
+
+This View shows how to switch the rows and columns from a QuickBase Report.
+
+<hr>
+
+<table border="1">
+
+   <tr>
+      <td></td>
+      <% for project in @projects do %>
+         <td><b><%= project.Company %></b></td>
+       <% end %>  
+   </tr>
+
+   <tr>
+      <td><b>Project Name</b></td>
+      <% for project in @projects do %>
+            <td><%= project["Project Name"] %></td>
+      <% end %>
+   </tr>
+   
+   <tr>
+      <td><b>Project Priority</b></td>
+      <% for project in @projects do %>
+            <td><%= project.Priority %></td>
+      <% end %>
+   </tr>
+   
+   <tr>
+      <td><b>Project Status</b></td>
+      <% for project in @projects do %>
+            <td><%= project.Status %></td>
+      <% end %>
+   </tr>
+
+</table>
+
+
+

data/examples/pmp/app/views/projects/projects_sorted_by_priority.rhtml

@@ -0,0 +1,30 @@
+<h1>Projects sorted by Priority, displayed from left to right</h1>
+
+The model method <i>Projects.projects_sorted_by_priority</i>, in projects.rb, shows how to 
+get records using the low-level <i>execute</i> method from the QuickBase adapter. Note that using 
+<i>execute</i> effectively bypasses ActiveRecord, but you can access column values using Ruby's 
+Hash syntax, e.g. <i>project["Project Name"]</i>
+
+<hr>
+
+<table border="1">
+
+   <tr>
+      <td><b>Project Name</b></td>
+      <% for project in @projects do %>
+            <td><%= project["Project Name"] %></td>
+      <% end %>
+   </tr>
+   
+   <tr>
+      <td><b>Project Summary</b></td>
+      <% for project in @projects do %>
+            <td><%= project["Project Summary"] %></td>
+      <% end %>
+   </tr>
+   
+
+</table>
+
+
+

data/examples/pmp/app/views/tasks/all_tasks.rhtml

@@ -0,0 +1,27 @@
+<h1>All Tasks</h1>
+
+This View shows how to display records from QuickBase without any model code and without
+ActiveRecord, by using the underlying QuickBase API directly.
+<p>
+It breaks the MVC paradigm, but it's not the end of the world!
+<hr>
+<% fieldNames = Array["Project Phase","Task Name","Duration", "Milestone","Start","Calculated Finish Date","Days Overdue","Status","Priority","% Complete"] %>
+
+<table border="1">
+<tr>
+   <% fieldNames.each{|fieldName| %>
+      <td><b><%= fieldName %></b></td>
+   <% } %>
+</tr>
+
+<% dbid = ActiveRecord::Base.connection.setActiveTable("Tasks") %>
+<% qbClient = ActiveRecord::Base.connection.raw_connection %>
+<% qbClient.iterateRecords(dbid, fieldNames, nil,nil, "All Tasks") { |task| %>
+   <tr>
+      <% fieldNames.each{ |fieldName| %>
+         <td><%= qbClient.formatFieldValue(task[fieldName],qbClient.lookupFieldTypeByName(fieldName)) %></td>
+      <% } %>
+   </tr>
+<% } %>
+
+</table>

data/examples/pmp/app/views/tasks/search.rhtml

@@ -0,0 +1,23 @@
+<h1>Tasks: find all records for which any field contains '<%= params[:s] %>'</h1>
+
+This View shows how to search QuickBase records using the query language in the QuickBase HTTP API.
+<hr>
+
+<% fieldNames = Array["Project Name","Project Phase","Task Name","Milestone","Duration", "Start","Calculated Finish Date","Actual Finish Date","Days Overdue","% Complete","Status","Priority"] %>
+
+<table border="1">
+<tr>
+   <% fieldNames.each{|fieldName| %>
+      <td><b><%= fieldName %></b></td>
+   <% } %>
+</tr>
+
+<% for task in @tasks do %>
+   <tr>
+      <% fieldNames.each{ |fieldName| %>
+         <td><%= task[fieldName] %></td>
+      <% } %>
+   </tr>
+<% end %>
+
+</table>

data/examples/pmp/app/views/tasks/search2.rhtml

@@ -0,0 +1,23 @@
+<h1>Tasks with Status = '<%= params[:status] %>'</h1>
+
+This View shows how to search QuickBase records using a simple SQL statement.
+<hr>
+
+<% fieldNames = Array["Project Name","Project Phase","Task Name","Milestone","Duration", "Start","Calculated Finish Date","Actual Finish Date","Days Overdue","% Complete","Status","Priority"] %>
+
+<table border="1">
+<tr>
+   <% fieldNames.each{|fieldName| %>
+      <td><b><%= fieldName %></b></td>
+   <% } %>
+</tr>
+
+<% for task in @tasks do %>
+   <tr>
+      <% fieldNames.each{ |fieldName| %>
+         <td><%= task[fieldName] %></td>
+      <% } %>
+   </tr>
+<% end %>
+
+</table>

data/examples/pmp/app/views/tasks/search3.rhtml

@@ -0,0 +1,23 @@
+<h1>Tasks with Status = '<%= params[:status] %>'</h1>
+
+This View shows how to search QuickBase records using a Rails 'find_all_by_??' method call.
+<hr>
+
+<% fieldNames = Array["Project Name","Project Phase","Task Name","Milestone","Duration", "Start","Calculated Finish Date","Actual Finish Date","Days Overdue","% Complete","Status","Priority"] %>
+
+<table border="1">
+<tr>
+   <% fieldNames.each{|fieldName| %>
+      <td><b><%= fieldName %></b></td>
+   <% } %>
+</tr>
+
+<% for task in @tasks do %>
+   <tr>
+      <% fieldNames.each{ |fieldName| %>
+         <td><%= task[fieldName] %></td>
+      <% } %>
+   </tr>
+<% end %>
+
+</table>

data/examples/pmp/app/views/time_cards/summary.rhtml

@@ -0,0 +1,38 @@
+<h1>Time Cards</h1>
+
+
+<hr>
+
+<% fieldList = Array["Project Name","Week Starting On","Sun","Mon","Tue","Wed","Thu","Fri","Sat","Weekly Total"] %>
+<% totalFieldList = Array["Sun","Mon","Tue","Wed","Thu","Fri","Sat","Weekly Total"] %>
+<% totals = {} %>
+<% totalFieldList.each {|fieldName| totals[fieldName] = 0} %>
+
+<table border="1">
+   
+   <tr>
+      <% fieldList.each {|fieldName| %>
+         <td><b><%= fieldName %></b></td>
+      <% } %>
+   </tr>
+
+   <% for rec in @time_cards do %>
+      <tr>
+         <% fieldList.each {|fieldName| %>
+            <td><%= rec[fieldName] %></td>
+         <% } %>
+      </tr>
+      <% totalFieldList.each {|fieldName| totals[fieldName] += rec[fieldName].to_i } %>
+   <% end %>   
+   
+   <tr>
+      <% fieldList.each {|fieldName| %>
+         <%  if totalFieldList.include?(fieldName) %>
+                  <td><b><%= totals[fieldName] %></b></td>
+         <%  else %>
+                  <td></td>
+         <%  end %>
+      <% } %>
+   </tr>
+
+</table>

data/examples/pmp/config/boot.rb

@@ -0,0 +1,45 @@
+# Don't change this file. Configuration is done in config/environment.rb and config/environments/*.rb
+
+unless defined?(RAILS_ROOT)
+  root_path = File.join(File.dirname(__FILE__), '..')
+
+  unless RUBY_PLATFORM =~ /(:?mswin|mingw)/
+    require 'pathname'
+    root_path = Pathname.new(root_path).cleanpath(true).to_s
+  end
+
+  RAILS_ROOT = root_path
+end
+
+unless defined?(Rails::Initializer)
+  if File.directory?("#{RAILS_ROOT}/vendor/rails")
+    require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+  else
+    require 'rubygems'
+
+    environment_without_comments = IO.readlines(File.dirname(__FILE__) + '/environment.rb').reject { |l| l =~ /^#/ }.join
+    environment_without_comments =~ /[^#]RAILS_GEM_VERSION = '([\d.]+)'/
+    rails_gem_version = $1
+
+    if version = defined?(RAILS_GEM_VERSION) ? RAILS_GEM_VERSION : rails_gem_version
+      # Asking for 1.1.6 will give you 1.1.6.5206, if available -- makes it easier to use beta gems
+      rails_gem = Gem.cache.search('rails', "~>#{version}.0").sort_by { |g| g.version.version }.last
+
+      if rails_gem
+        gem "rails", "=#{rails_gem.version.version}"
+        require rails_gem.full_gem_path + '/lib/initializer'
+      else
+        STDERR.puts %(Cannot find gem for Rails ~>#{version}.0:
+    Install the missing gem with 'gem install -v=#{version} rails', or
+    change environment.rb to define RAILS_GEM_VERSION with your desired version.
+  )
+        exit 1
+      end
+    else
+      gem "rails"
+      require 'initializer'
+    end
+  end
+
+  Rails::Initializer.run(:set_load_path)
+end

data/examples/pmp/config/database.yml

@@ -0,0 +1,30 @@
+development:
+  adapter: quickbase
+  database: Project Manager Plus
+  username: 
+  password: 
+  printRequestsAndResponses: false
+  cacheSchemas: true
+  decimalPrecision: 38	
+  host: localhost
+
+# Warning: The database defined as 'test' will be erased and
+# re-generated from your development database when you run 'rake'.
+# Do not set this db to the same as development or production.
+test:
+  adapter: quickbase
+  database: Project Manager Plus
+  username: 
+  password: 
+  cacheSchemas: true
+  decimalPrecision: 38	
+  host: localhost
+
+production:
+  adapter: quickbase
+  database: Project Manager Plus
+  username: 
+  password: 
+  cacheSchemas: true
+  decimalPrecision: 38	
+  host: localhost

data/examples/pmp/config/environment.rb

@@ -0,0 +1,60 @@
+# Be sure to restart your web server when you modify this file.
+
+# Uncomment below to force Rails into production mode when 
+# you don't control web/app server and can't set it the proper way
+# ENV['RAILS_ENV'] ||= 'production'
+
+# Specifies gem version of Rails to use when vendor/rails is not present
+RAILS_GEM_VERSION = '1.2.3' unless defined? RAILS_GEM_VERSION
+
+# Bootstrap the Rails environment, frameworks, and default configuration
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  # Settings in config/environments/* take precedence over those specified here
+  
+  # Skip frameworks you're not going to use (only works if using vendor/rails)
+  # config.frameworks -= [ :action_web_service, :action_mailer ]
+
+  # Only load the plugins named here, by default all plugins in vendor/plugins are loaded
+  # config.plugins = %W( exception_notification ssl_requirement )
+
+  # Add additional load paths for your own custom dirs
+  # config.load_paths += %W( #{RAILS_ROOT}/extras )
+
+  # Force all environments to use the same logger level 
+  # (by default production uses :info, the others :debug)
+  # config.log_level = :debug
+
+  # Use the database for sessions instead of the file system
+  # (create the session table with 'rake db:sessions:create')
+  # config.action_controller.session_store = :active_record_store
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper, 
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  # Activate observers that should always be running
+  # config.active_record.observers = :cacher, :garbage_collector
+
+  # Make Active Record use UTC-base instead of local time
+  # config.active_record.default_timezone = :utc
+  
+  # See Rails::Configuration for more options
+end
+
+# Add new inflection rules using the following format 
+# (all these examples are active by default):
+# Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register "application/x-mobile", :mobile
+
+# Include your application configuration below