quickbase 0.0.1

data/README.rdoc

@@ -0,0 +1,42 @@
+= Quickbase Ruby Gem
+
+The Quickbase Gem provides integration access to the Intuit Quickbase API.
+
+== Dependencies
+
+* httparty
+* libxml-ruby
+* activesupport
+
+== Installation
+
+  gem install quickbase
+
+or, in your Gemfile
+
+  gem 'quickbase'
+
+== Quick Start Example
+
+  Quickbase::Connection.username = QUICKBASE_USERNAME
+  Quickbase::Connection.password = QUICKBASE_PASSWORD
+  Quickbase::Connection.org = QUICKBASE_ORGANIZATION # defaults to www
+
+  require "rubygems"
+  require "quickbase"
+
+  quickbase = Quickbase::Connection.new(:apptoken => "apptoken", :dbid => "dbid")
+
+  records = quickbase.api.do_query(:query => "{'3'.EX.'5'}", :slist => "3", :clist => "3.6.7")
+
+== More Examples
+
+  quickbase = Quickbase::Connection.new(:apptoken => "apptoken", :dbid => "dbid")
+
+  quickbase.api.add_record({:name => "John Smith", "6" => "New York City"})
+
+  quickbase.api.edit_record(6, {:city => "Washington"})
+
+  quickbase.api.delete_record(7)
+
+==

data/lib/classes/api.rb

@@ -0,0 +1,44 @@
+module Quickbase
+  class Api
+    attr_accessor :connection
+  
+    def initialize(connection)
+      instance_variable_set "@connection", connection
+    end
+  
+    # Documentation at http://www.quickbase.com/api-guide/do_query.html
+    def do_query(params)
+      params.merge!({:fmt => "structured"})
+      clist = params[:clist].to_s.split(".")
+      response = connection.http.post("API_DoQuery", Quickbase::Helper.hash_to_xml(params))
+      array_of_records = response.find("//record[@type='array']/record")
+      records = array_of_records.empty? ? response.find("//record") : array_of_records
+      return [] if records.empty?
+
+      records.map{|record|
+        array_of_fields = record.find("f[@type='array']/f")
+        fields = array_of_fields.empty? ? record.find("f") : array_of_fields
+        Hash[fields.to_enum(:each_with_index).collect{|field,index| Hash[clist[index],field.content] }.map(&:flatten)]
+      }
+    end
+    
+    # Documentation at http://www.quickbase.com/api-guide/add_record.html
+    def add_record(fields)
+      fields = Quickbase::Helper.generate_fields(fields)
+      connection.http.post("API_AddRecord", fields)
+    end
+    
+    # Documentation at http://www.quickbase.com/api-guide/edit_record.html
+    def edit_record(rid, fields)
+      tags = Quickbase::Helper.generate_fields(fields)
+      tags << Quickbase::Helper.hash_to_xml({:rid => rid.to_s})
+      connection.http.post("API_EditRecord", tags)
+    end
+    
+    # Documentation at http://www.quickbase.com/api-guide/delete_record.html
+    def delete_record(rid)
+      tags = Quickbase::Helper.hash_to_xml({:rid => rid.to_s})
+      connection.http.post("API_DeleteRecord", tags)
+    end
+  end
+end

data/lib/classes/connection.rb

@@ -0,0 +1,44 @@
+module Quickbase
+  class Connection
+    class << self
+      attr_writer :username, :password, :hours, :apptoken, :dbid, :org
+    end
+    attr_reader :username, :password, :hours, :apptoken, :dbid, :org
+  
+    def self.expectant_reader(*attributes)
+      attributes.each do |attribute|
+        (class << self; self; end).send(:define_method, attribute) do
+          attribute_value = instance_variable_get("@#{attribute}")
+          attribute_value
+        end
+      end
+    end
+    expectant_reader :username, :password, :hours, :apptoken, :dbid, :org
+  
+    def initialize(options = {})
+      [:username, :password, :hours, :apptoken, :dbid, :org].each do |attr|
+        instance_variable_set "@#{attr}", (options[attr].nil? ? Quickbase::Connection.send(attr) : options[attr])
+      end
+      instance_variable_set "@org", "www" if org.nil?
+    end
+  
+    def instantiate
+      config = {
+        :username => username,
+        :password => password,
+        :hours => hours,
+        :apptoken => apptoken,
+        :dbid => dbid,
+        :org => org
+      }
+    end
+  
+    def http
+      Quickbase::Http.new(instantiate)
+    end
+  
+    def api
+      Quickbase::Api.new(self)
+    end
+  end
+end

data/lib/classes/helper.rb

@@ -0,0 +1,24 @@
+module Quickbase
+  class Helper
+    def self.hash_to_xml(hash)
+      hash.map{|key,value| 
+        tag = LibXML::XML::Node.new(key)
+        tag.content = value.to_s
+        tag
+      }
+    end
+    
+    def self.generate_xml(params)
+      LibXML::XML::Document.string("<qdbapi>#{params.join}</qdbapi>")
+    end
+    
+    def self.generate_fields(fields)
+      fields.map{|key,value|
+        field = LibXML::XML::Node.new("field")
+        key =~ /^[-+]?[0-9]+$/ ? field["fid"] = key.to_s : field["name"] = key.to_s
+        field.content = value
+        field
+      }
+    end
+  end
+end

data/lib/classes/http.rb

@@ -0,0 +1,40 @@
+module Quickbase
+  class Http
+    include HTTParty
+    attr_accessor :qb_params
+  
+    def initialize(config)
+      self.class.base_uri "https://#{config[:org]}.quickbase.com"
+      instance_variable_set "@qb_params", {:dbid => "main"}
+      response = post("API_Authenticate", Quickbase::Helper.hash_to_xml(config))
+      qb_params[:ticket] = response.find_first("//ticket").content
+      qb_params[:apptoken] = config[:apptoken]
+      qb_params[:dbid] = config[:dbid]
+    end
+      
+    def post(quickbase_action, params = [])
+      params = params.concat(Quickbase::Helper.hash_to_xml(qb_params))
+      clean_xml_string = Quickbase::Helper.generate_xml(params).to_s
+      self.class.headers({"Content-Length" => clean_xml_string.length.to_s})
+      self.class.headers({"Content-Type" => "application/xml"})
+      self.class.headers({"QUICKBASE-ACTION" => quickbase_action})
+      response = LibXML::XML::Document.string(self.class.post("/db/#{qb_params[:dbid]}", :body => clean_xml_string).to_xml)
+      error_handler(response)
+      response
+    end
+  
+    private
+    
+    def error_handler(response)
+      case response.find_first("//errcode").content.to_i
+      when 0
+        return true
+      else
+        errcode = response.find_first('//errcode').content
+        errtext = response.find_first('//errtext').content
+        raise "#{errcode}: #{errtext}"
+        return false
+      end
+    end
+  end
+end

data/lib/quickbase.rb

@@ -0,0 +1,8 @@
+require "libxml"
+require "httparty"
+require "active_support/all"
+
+require File.dirname(__FILE__) + "/classes/api.rb"
+require File.dirname(__FILE__) + "/classes/connection.rb"
+require File.dirname(__FILE__) + "/classes/helper.rb"
+require File.dirname(__FILE__) + "/classes/http.rb"

data/quickbase.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name = %q{quickbase}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Artem Kalinchuk"]
+  s.date = %q{2011-09-19}
+  s.description = %q{The Quickbase Gem provides integration access to the Intuit Quickbase API.}
+  s.email = %q{artem9@gmail.com}
+  s.files = ["lib/quickbase.rb", "quickbase.gemspec", "README.rdoc", "lib/classes/api.rb", "lib/classes/connection.rb", "lib/classes/helper.rb", "lib/classes/http.rb"]
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Quickbase"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{quickbase}
+  s.rubygems_version = %q{1.8.5}
+  s.summary = %q{Quickbase Ruby Gem}
+  s.add_dependency(%q<libxml-ruby>, [">= 0"])
+  s.add_dependency(%q<httparty>, [">= 0"])
+  s.add_dependency(%q<activesupport>, [">= 0"])
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: quickbase
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Artem Kalinchuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-19 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: libxml-ruby
+  requirement: &4708360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *4708360
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &4707830 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *4707830
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &4707380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *4707380
+description: The Quickbase Gem provides integration access to the Intuit Quickbase
+  API.
+email: artem9@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/quickbase.rb
+- quickbase.gemspec
+- README.rdoc
+- lib/classes/api.rb
+- lib/classes/connection.rb
+- lib/classes/helper.rb
+- lib/classes/http.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- Quickbase
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.2'
+requirements: []
+rubyforge_project: quickbase
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Quickbase Ruby Gem
+test_files: []