quickbase 0.0.3 → 0.0.4

data/README.rdoc

@@ -5,7 +5,7 @@ The Quickbase Gem provides integration access to the Intuit Quickbase API.
 == Dependencies
 
 * httparty
-* libxml-ruby
+* nokogiri
 * activesupport
 
 == Installation
@@ -41,4 +41,9 @@ or, in your Gemfile
 
   quickbase.api.delete_record(7)
 
-==
+== Changes
+
+  01/13/2012
+  - Api was changed to API. Http was changed to HTTP.
+  - RSpec was added for testing.
+  - Replaced LibXML with Nokogiri

data/lib/classes/api.rb

@@ -1,5 +1,5 @@
 module Quickbase
-  class Api
+  class API
     attr_accessor :connection
   
     def initialize(connection)
@@ -13,15 +13,15 @@ module Quickbase
       friendly = params[:friendly].to_s.split(".")
       keys = friendly.empty? ? clist : friendly.map(&:to_sym)
       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
+      array_of_records = response.xpath("//record[@type='array']/record")
+      records = array_of_records.empty? ? response.xpath("//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
+        array_of_fields = record.xpath("f[@type='array']/f")
+        fields = array_of_fields.empty? ? record.xpath("f") : array_of_fields
         Hash[fields.to_enum(:each_with_index).collect{|field,index|
-          field.content = "" unless field.find_first("id").nil? # QuickBase adds ID to the tag if its empty
+          field.content = "" unless field.xpath("id").first.nil? # QuickBase adds ID to the tag if its empty
           Hash[keys[index],field.content] 
         }.map(&:flatten)]
       }
@@ -46,4 +46,8 @@ module Quickbase
       connection.http.post("API_DeleteRecord", tags)
     end
   end
+  
+  class Api < API
+    puts "Class Api will be deprecated. Please use API instead."
+  end
 end

data/lib/classes/connection.rb

@@ -34,11 +34,11 @@ module Quickbase
     end
   
     def http
-      Quickbase::Http.new(instantiate)
+      Quickbase::HTTP.new(instantiate)
     end
   
     def api
-      Quickbase::Api.new(self)
+      Quickbase::API.new(self)
     end
   end
 end

data/lib/classes/helper.rb

@@ -1,23 +1,20 @@
 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
+      hash.map{|key,value|
+        "<#{key}>#{value}</#{key}>"
       }
     end
     
     def self.generate_xml(params)
-      LibXML::XML::Document.string("<qdbapi>#{params.join}</qdbapi>")
+      Nokogiri::XML("<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
+        field = "<field "
+        fid = (key =~ /^[-+]?[0-9]+$/) ? field.concat('fid="'+key.to_s+'"') : field.concat('name="'+key.to_s+'"')
+        field.concat(">#{value}</field>")
       }
     end
   end

data/lib/classes/http.rb

@@ -1,5 +1,5 @@
 module Quickbase
-  class Http
+  class HTTP
     include HTTParty
     attr_accessor :qb_params
   
@@ -7,7 +7,7 @@ module Quickbase
       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[:ticket] = response.xpath("//ticket").first.content
       qb_params[:apptoken] = config[:apptoken]
       qb_params[:dbid] = config[:dbid]
     end
@@ -18,7 +18,7 @@ module Quickbase
       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)
+      response = Nokogiri::XML([self.class.post("/db/#{qb_params[:dbid]}", :body => clean_xml_string)].to_xml)
       error_handler(response)
       response
     end
@@ -26,15 +26,19 @@ module Quickbase
     private
     
     def error_handler(response)
-      case response.find_first("//errcode").content.to_i
+      case response.xpath("//errcode").first.content.to_i
       when 0
         return true
       else
-        errcode = response.find_first('//errcode').content
-        errtext = response.find_first('//errtext').content
+        errcode = response.xpath('//errcode').first.content
+        errtext = response.xpath('//errtext').first.content
         raise "#{errcode}: #{errtext}"
         return false
       end
     end
   end
+  
+  class Http < HTTP
+    puts "Class Http will be deprecated. Please use HTTP instead."
+  end
 end

data/lib/quickbase.rb

@@ -1,4 +1,4 @@
-require "libxml"
+require "nokogiri"
 require "httparty"
 require "active_support/all"
 

data/quickbase.gemspec

@@ -1,19 +1,19 @@
 Gem::Specification.new do |s|
   s.name = %q{quickbase}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   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.files = ["lib/quickbase.rb", "quickbase.gemspec", "README.rdoc", "lib/classes/api.rb", "lib/classes/connection.rb", "lib/classes/helper.rb", "lib/classes/http.rb", "spec/quickbase_spec.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<nokogiri>, [">= 0"])
   s.add_dependency(%q<httparty>, [">= 0"])
   s.add_dependency(%q<activesupport>, [">= 0"])
 end

data/spec/quickbase_spec.rb

@@ -0,0 +1,75 @@
+gem "activerecord"
+require "active_record"
+require "cgi"
+require 'pp'
+
+require File.dirname(__FILE__) + "/../lib/quickbase.rb"
+
+Quickbase::Connection.username = ""
+Quickbase::Connection.password = ""
+Quickbase::Connection.org = ""
+apptoken = ""
+dbid = ""
+
+describe Quickbase::Connection do
+  describe "initialize" do
+    it "initializes successfully" do
+      quickbase = Quickbase::Connection.new(:apptoken => apptoken, :dbid => dbid)
+      
+      connection_hash = {
+        :apptoken => quickbase.apptoken,
+        :dbid => quickbase.dbid,
+        :hours => quickbase.hours,
+        :org => quickbase.org,
+        :password => quickbase.password,
+        :username => quickbase.username
+      }
+      
+      default_values_hash = {
+        :apptoken => apptoken,
+        :dbid => dbid,
+        :hours => nil,
+        :org => Quickbase::Connection.org,
+        :password => Quickbase::Connection.password,
+        :username => Quickbase::Connection.username
+      }
+      
+      connection_hash.should == default_values_hash
+    end
+  end
+end
+
+describe Quickbase::Helper do
+  describe "self.hash_to_xml" do
+    it "creates XML out of a hash" do
+      hash = {:test => "this is the content of the test tag", :test2 => "contents of test2"}
+    
+      Quickbase::Helper.hash_to_xml(hash).join.should == "<test>this is the content of the test tag</test><test2>contents of test2</test2>"
+    end
+  end
+  
+  describe "self.generate_xml" do
+    it "returns a formatted Quickbase XML" do
+      hash = {:test => "this is the content of the test tag", :test2 => "contents of test2"}
+      Quickbase::Helper.generate_xml(Quickbase::Helper.hash_to_xml(hash)).to_s.should == Nokogiri::XML("<qdbapi><test>this is the content of the test tag</test><test2>contents of test2</test2></qdbapi>").to_s
+    end
+  end
+  
+  describe "self.generate_fields" do
+    it "creates an array of tags with all the fields" do
+      fields = {:first_name => "John", :last_name => "Smith"}
+      Quickbase::Helper.generate_fields(fields).should ==  ["<field name=\"first_name\">John</field>", "<field name=\"last_name\">Smith</field>"]
+    end
+  end
+end
+
+describe Quickbase::API do
+  describe "do_query" do
+    it "queries for data" do
+      quickbase = Quickbase::Connection.new(:apptoken => apptoken, :dbid => dbid)
+      
+      results = quickbase.api.do_query(:query => "{'1'.XEX.'1'}", :clist => "1.2", :slist => "1")
+      results.length.should_not == 0
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quickbase
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -12,8 +12,8 @@ cert_chain: []
 date: 2011-09-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: libxml-ruby
-  requirement: &4866690 !ruby/object:Gem::Requirement
+  name: nokogiri
+  requirement: &70162225377940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *4866690
+  version_requirements: *70162225377940
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &4865550 !ruby/object:Gem::Requirement
+  requirement: &70162225376800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *4865550
+  version_requirements: *70162225376800
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &4845320 !ruby/object:Gem::Requirement
+  requirement: &70162225374140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *4845320
+  version_requirements: *70162225374140
 description: The Quickbase Gem provides integration access to the Intuit Quickbase
   API.
 email: artem9@gmail.com
@@ -58,6 +58,7 @@ files:
 - lib/classes/connection.rb
 - lib/classes/helper.rb
 - lib/classes/http.rb
+- spec/quickbase_spec.rb
 homepage: 
 licenses: []
 post_install_message: