quickeebooks 0.1.2 → 0.1.3

data/lib/quickeebooks/windows/service/service_base.rb

@@ -26,7 +26,7 @@ module Quickeebooks
 
         def initialize(oauth_access_token = nil, realm_id = nil)
           @base_uri = 'https://services.intuit.com/sb'
-          
+
           if !oauth_access_token.nil? && !realm_id.nil?
             msg = "Quickeebooks::Windows::ServiceBase - "
             msg += "This version of the constructor is deprecated. "
@@ -36,11 +36,11 @@ module Quickeebooks
             realm_id = realm_id
           end
         end
-        
+
         def access_token=(token)
           @oauth = token
         end
-        
+
         def realm_id=(realm_id)
           @realm_id = realm_id
         end
@@ -52,7 +52,7 @@ module Quickeebooks
         def url_for_base(raw)
           "#{@base_uri}/#{raw}/v2/#{@realm_id}"
         end
-        
+
         def guid
           UUIDTools::UUID.random_create.to_s.gsub('-', '')
         end
@@ -60,7 +60,7 @@ module Quickeebooks
         private
 
         def parse_xml(xml)
-          @last_response_xml = 
+          @last_response_xml =
           begin
             x = Nokogiri::XML(xml)
             #x.document.remove_namespaces!
@@ -71,7 +71,7 @@ module Quickeebooks
         def valid_xml_document(xml)
           %Q{<?xml version="1.0" encoding="utf-8"?>\n#{xml.strip}}
         end
-        
+
         # In QBD a single object response is the same as a collection response except
         # it just has a single main element
         def fetch_object(model, url, params = {}, options = {})
@@ -88,14 +88,29 @@ module Quickeebooks
         def fetch_collection(model, custom_field_query = nil, filters = [], page = 1, per_page = 20, sort = nil, options ={})
           raise ArgumentError, "missing model to instantiate" if model.nil?
 
-          if custom_field_query != nil
-            response = do_http_post(url_for_resource(model::REST_RESOURCE), custom_field_query, {}, {'Content-Type' => 'text/xml'})
-          else
-            response = do_http_get(url_for_resource(model::REST_RESOURCE), {}, {'Content-Type' => 'text/html'})
+          post_body_tags = []
+
+          if filters.is_a?(Array) && filters.length > 0
+            post_body_tags << filters.collect { |f| f.to_xml }
+            post_body_tags.flatten!
+          end
+
+          post_body_tags << "<StartPage>#{page}</StartPage>"
+          post_body_tags << "<ChunkSize>#{per_page}</ChunkSize>"
+
+          if sort
+            post_body_tags << sort.to_xml
           end
+
+          post_body_tags << custom_field_query
+
+          xml_query_tag = "#{model::XML_NODE}Query"
+          body = %Q{<?xml version="1.0" encoding="utf-8"?>\n<#{xml_query_tag} xmlns="http://www.intuit.com/sb/cdm/v2">#{post_body_tags.join}</#{xml_query_tag}>}
+
+          response = do_http_post(url_for_resource(model::REST_RESOURCE), body, {}, {'Content-Type' => 'text/xml'})
           parse_collection(response, model)
         end
-        
+
         def parse_collection(response, model)
           if response
             collection = Quickeebooks::Collection.new
@@ -121,14 +136,14 @@ module Quickeebooks
             nil
           end
         end
-        
+
         def perform_write(model, body = "", params = {}, headers = {})
           url = url_for_resource(model::REST_RESOURCE)
           unless headers.has_key?('Content-Type')
             headers['Content-Type'] = 'text/xml'
           end
           response = do_http_post(url, body.strip, params, headers)
-          
+
           result = nil
           if response
             case response.code.to_i
@@ -195,7 +210,7 @@ module Quickeebooks
             raise "HTTP Error Code: #{status}, Msg: #{response.body}"
           end
         end
-        
+
         def parse_and_raise_exceptione
           err = parse_intuit_error
           ex = IntuitRequestException.new(err[:message])
@@ -203,7 +218,7 @@ module Quickeebooks
           ex.cause = err[:cause]
           raise ex
         end
-        
+
         def response_is_error?
           @last_response_xml.xpath("//xmlns:RestResponse/xmlns:Error").first != nil
         end

data/lib/quickeebooks/windows/service/sort.rb

@@ -0,0 +1,8 @@
+module Quickeebooks
+  module Windows
+    module Service
+      class Sort < Quickeebooks::Shared::Service::Sort
+      end
+    end
+  end
+end

data/lib/quickeebooks.rb

@@ -7,19 +7,19 @@ class InvalidModelException < Exception; end
 
 module Quickeebooks
   @@logger = nil
-  
+
   def self.logger
     @@logger || Logger.new($stdout) # TODO: replace with a real log file
   end
-  
+
   def self.logger=(logger)
     @@logger = logger
   end
-  
+
   class Collection
     attr_accessor :entries, :count, :current_page
   end
-  
+
 end
 
 # monkey-path the to_xml method to add support for passing
@@ -36,7 +36,7 @@ module ROXML
         refs = (self.roxml_references.present? \
           ? self.roxml_references \
           : self.class.roxml_attrs.map {|attr| attr.to_ref(self) })
-        
+
         if params[:fields].length > 0
           refs.reject! { |r| !params[:fields].include?(r.name) }
         end
@@ -56,6 +56,7 @@ end
 # Services
 require 'quickeebooks/shared/service/filter'
 require 'quickeebooks/shared/service/access_token'
+require 'quickeebooks/shared/service/sort'
 
 #== Online
 
@@ -64,6 +65,9 @@ require 'quickeebooks/online/model/intuit_type'
 require 'quickeebooks/online/model/company_meta_data'
 require 'quickeebooks/online/model/customer'
 require 'quickeebooks/online/model/account'
+require 'quickeebooks/online/model/bill'
+require 'quickeebooks/online/model/bill_header'
+require 'quickeebooks/online/model/bill_line_item'
 require 'quickeebooks/online/model/invoice'
 require 'quickeebooks/online/model/invoice_header'
 require 'quickeebooks/online/model/invoice_line_item'
@@ -87,6 +91,7 @@ require 'quickeebooks/online/service/sort'
 require 'quickeebooks/online/service/company_meta_data'
 require 'quickeebooks/online/service/customer'
 require 'quickeebooks/online/service/account'
+require 'quickeebooks/online/service/bill'
 require 'quickeebooks/online/service/invoice'
 require 'quickeebooks/online/service/item'
 require 'quickeebooks/online/service/entitlement'
@@ -134,6 +139,7 @@ require 'quickeebooks/windows/model/sales_receipt'
 
 # Services
 require 'quickeebooks/windows/service/filter'
+require 'quickeebooks/windows/service/sort'
 require 'quickeebooks/windows/service/service_base'
 require 'quickeebooks/windows/service/account'
 require 'quickeebooks/windows/service/customer'

data/quickeebooks.gemspec

@@ -19,9 +19,9 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'nokogiri'
   gem.add_dependency 'activemodel'
   gem.add_dependency 'uuidtools'
-  
+
   gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rcov',   '~> 0.9.8'
+  gem.add_development_dependency 'simplecov'
   gem.add_development_dependency 'rr',     '~> 1.0.2'
   gem.add_development_dependency 'rspec',  '2.11.0'
   gem.add_development_dependency 'fakeweb'

data/spec/quickeebooks/common/online_line_item_model_methods_spec.rb

@@ -0,0 +1,41 @@
+describe 'Mixin for online models that have line items' do
+
+  let (:shared_models) { %w(Invoice Payment Bill) }
+
+  it 'initializes' do
+    shared_models.each do |model|
+      klass = "Quickeebooks::Online::Model::#{model}".constantize
+      klass.new.line_items.size == 0
+      xml = onlineFixture("#{model.downcase}.xml")
+      klass.from_xml(xml).line_items.size.should == 1
+    end
+  end
+
+  it 'references constants' do
+    shared_models.each do |model|
+      klass = "Quickeebooks::Online::Model::#{model}".constantize
+      klass.resource_for_collection.should == "#{model.downcase}s"
+      klass.new.to_xml_ns.should == "<#{model}/>"
+    end
+  end
+
+  it 'valid for updates' do
+    shared_models.each do |model|
+      klass = "Quickeebooks::Online::Model::#{model}".constantize.new
+      klass.valid_for_update?.should be_true
+      klass.errors.add(:id, 'no user')
+      klass.valid_for_update?.should be_false
+    end
+  end
+
+  it 'valid for deletion' do
+    shared_models.each do |model|
+      klass = "Quickeebooks::Online::Model::#{model}".constantize
+      xml = onlineFixture("#{model.downcase}.xml")
+      item = klass.from_xml(xml)
+      item.valid_for_deletion?.should be_true
+    end
+  end
+
+end
+

data/spec/quickeebooks/common/service_crud_spec.rb

@@ -0,0 +1,41 @@
+describe 'Mixin CRUD like methods for various service modules' do
+
+  context 'model method' do
+    it 'should constantize properly for an online service' do
+      service = Quickeebooks::Online::Service::Bill.new
+      service.model.should be_a(Class)
+      service.model.to_s.should == "Quickeebooks::Online::Model::Bill"
+    end
+
+    it 'should constantize properly for a windows service' do
+      expect {
+        # Test build_dummy first
+        build_dummy_windows_service
+        Quickeebooks::Windows::Service::TEST.new.model
+      }.to raise_exception NoMethodError
+
+      build_dummy_windows_service('include ServiceCRUD')
+      service = Quickeebooks::Windows::Service::TEST.new
+      service.model.should be_a(Class)
+      service.model.to_s.should == "Quickeebooks::Windows::Model::TEST"
+    end
+
+    def build_dummy_windows_service(inc = '')
+      eval("
+        module Quickeebooks
+          module Windows
+            module Service
+              class TEST < Quickeebooks::Windows::Service::ServiceBase
+                #{inc} 
+              end
+            end
+            module Model
+              class TEST < Quickeebooks::Windows::Model::IntuitType
+              end
+            end
+          end
+        end
+      ", TOPLEVEL_BINDING)
+    end
+  end
+end

data/spec/quickeebooks/online/account_spec.rb

@@ -1,9 +1,5 @@
-require "spec_helper"
-require "stringio"
-require "quickeebooks/online/model/account"
-
 describe "Quickeebooks::Online::Model::Account" do
-  
+
   it "should convert Ruby to XML" do
     account = Quickeebooks::Online::Model::Account.new
     account.sync_token = 1
@@ -14,7 +10,7 @@ describe "Quickeebooks::Online::Model::Account" do
     xml = account.to_xml(:fields => 'Name').write_to(s, :indent => 0, :indent_text => '')
     xml.string.gsub(/\n/, '').should == expected
   end
-  
+
   it "has a validation error on invalid subtype" do
     account = Quickeebooks::Online::Model::Account.new
     account.sub_type = "invalid"
@@ -32,10 +28,10 @@ describe "Quickeebooks::Online::Model::Account" do
     account.sub_type = "AccountsPayable"
     account.valid?.should == true
   end
-  
+
   it "cannot delete an Account without providing required fields" do
     account = Quickeebooks::Online::Model::Account.new
     account.valid_for_deletion?.should == false
   end
-  
+
 end

data/spec/quickeebooks/online/bill_spec.rb

@@ -0,0 +1,17 @@
+describe "Quickeebooks::Online::Model::Bill" do
+
+  describe "parse bill from XML" do
+    xml = onlineFixture("bill.xml")
+    bill = Quickeebooks::Online::Model::Bill.from_xml(xml)
+    bill.header.doc_number.should == "2004"
+    bill.header.vendor_id.value.should == "7"
+    bill.header.sales_term_id.value.should == "5"
+    bill.header.total_amount.should == 50
+
+    bill.line_items.count.should == 1
+    bill.line_items.first.amount.should == 25
+    bill.line_items.first.billable_status.should == "NotBillable"
+    bill.line_items.first.reimbursable.customer_id.value.should == "5"
+  end
+
+end

data/spec/quickeebooks/online/company_meta_data_spec.rb

@@ -1,10 +1,7 @@
-require "spec_helper"
-require "quickeebooks/online/model/company_meta_data"
-
 describe "Quickeebooks::Online::Model::CompanyMetaData" do
-  
+
   it "parse company meta data from XML" do
-    xml = File.read(File.dirname(__FILE__) + "/../../xml/online/company_meta_data.xml")
+    xml = onlineFixture("company_meta_data.xml")
     company_meta_data = Quickeebooks::Online::Model::CompanyMetaData.from_xml(xml)
 
     company_meta_data.external_realm_id.should be_nil
@@ -14,16 +11,16 @@ describe "Quickeebooks::Online::Model::CompanyMetaData" do
     company_meta_data.industry_type.should == "Landscaping Services"
 
     company_meta_data.addresses.count.should == 2
-    
+
     company_meta_data.addresses.first.line1.should == "2600 Service Street"
 
     company_meta_data.legal_address.line1.should == "2602 Service Street"
-    
+
     company_meta_data.phone.free_form_number.should == "(669)111-2222"
-    
+
     company_meta_data.emails.size.should == 2
     company_meta_data.emails.first.address.should == "john@bayarealandscapeservices.com"
-    
+
     # Tag not supported yet in Quickeebooks::Online::Model::Email
     # company_meta_data.emails.first.tag.should == "COMPANY_EMAIL"
   end

data/spec/quickeebooks/online/customer_spec.rb

@@ -1,26 +1,22 @@
-require "spec_helper"
-
-require "quickeebooks/online/model/customer"
-
 describe "Quickeebooks::Online::Model::Customer" do
-  
+
   it "parse customer from XML" do
-    xml = File.read(File.dirname(__FILE__) + "/../../xml/online/customer.xml")
+    xml = onlineFixture("customer.xml")
     customer = Quickeebooks::Online::Model::Customer.from_xml(xml)
     customer.sync_token.should == 1
     customer.name.should == "John Doe"
-    
+
     create_time = Date.civil(2011, 9, 29)
     customer.meta_data.create_time.year.should == create_time.year
     customer.addresses.count.should == 2
-    
+
     customer.addresses.first.line1.should == "123 Main St."
-    
+
     customer.phones.size.should == 2
     customer.phones.first.free_form_number.should == "(408) 555-1212"
-    
+
     customer.email.address.should == "johndoe@gmail.com"
-    
+
     customer.notes.count.should == 1
     customer.notes.first.content.should == "Likes chocolate and horses"
 
@@ -28,7 +24,7 @@ describe "Quickeebooks::Online::Model::Customer" do
 
     customer.open_balance.amount.should == 6200.0
   end
-  
+
   it "can assign an email address" do
     customer = Quickeebooks::Online::Model::Customer.new
     the_email = "foo@example.org"
@@ -36,11 +32,11 @@ describe "Quickeebooks::Online::Model::Customer" do
     customer.email.is_a?(Quickeebooks::Online::Model::Email).should == true
     customer.email.address.should == the_email
   end
-  
+
   it "cannot update an invalid model" do
     customer = Quickeebooks::Online::Model::Customer.new
     customer.valid_for_update?.should == false
     customer.errors.keys.include?(:sync_token).should == true
   end
-  
+
 end

data/spec/quickeebooks/online/invoice_spec.rb

@@ -1,16 +1,12 @@
-require "spec_helper"
-
-require "quickeebooks/online/model/invoice"
-
 describe "Quickeebooks::Online::Model::Invoice" do
-  
+
   describe "parse invoice from XML" do
-    xml = File.read(File.dirname(__FILE__) + "/../../xml/online/invoice.xml")
+    xml = onlineFixture("invoice.xml")
     invoice = Quickeebooks::Online::Model::Invoice.from_xml(xml)
     invoice.header.balance.should == 0
     invoice.id.value.should == "13"
     invoice.line_items.count.should == 1
     invoice.line_items.first.unit_price.should == 225
   end
-  
+
 end

data/spec/quickeebooks/online/payment_spec.rb

@@ -1,23 +1,19 @@
-require "spec_helper"
-
-require "quickeebooks/online/model/payment"
-
 describe "Quickeebooks::Online::Model::Payment" do
-  
+
   describe "parse invoice from XML" do
-    xml = File.read(File.dirname(__FILE__) + "/../../xml/online/payment.xml")
+    xml = onlineFixture("payment.xml")
     invoice = Quickeebooks::Online::Model::Payment.from_xml(xml)
     invoice.id.value.should == "47"
     invoice.header.doc_number.should == "54"
     invoice.header.customer_id.value.should == "5"
     invoice.header.note.should == "Payment against Invoice"
     invoice.header.total_amount.should == 20.0
-    
+
     invoice.line_items.count.should == 1
     invoice.line_items.first.amount.should == 20.0
     invoice.line_items.first.txn_id.value.should == "8"
-    
+
     invoice.line_items.first.amount.should == invoice.header.total_amount
   end
-  
-end
+
+end

data/spec/quickeebooks/online/services/account_spec.rb

@@ -1,8 +1,3 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
-require "fakeweb"
-require "oauth"
-require "quickeebooks/online/service/account"
-
 describe "Quickeebooks::Online::Service::Account" do
   before(:all) do
     FakeWeb.allow_net_connect = false
@@ -24,14 +19,14 @@ describe "Quickeebooks::Online::Service::Account" do
       @realm_id = "9991111222"
     }
   end
-  
+
   it "receives 404 from invalid base URL" do
     uri = "https://qbo.intuit.com/invalid"
     url = @service.url_for_resource(Quickeebooks::Online::Model::Account.resource_for_collection)
     FakeWeb.register_uri(:post, url, :status => ["200", "OK"], :body => "blah")
     lambda { @service.list }.should raise_error(IntuitRequestException)
   end
-  
+
   it "can fetch a list of accounts" do
     xml = File.read(File.dirname(__FILE__) + "/../../../xml/online/accounts.xml")
     url = @service.url_for_resource(Quickeebooks::Online::Model::Account.resource_for_collection)
@@ -41,7 +36,7 @@ describe "Quickeebooks::Online::Service::Account" do
     accounts.entries.count.should == 10
     accounts.entries.first.current_balance.should == 6200
   end
-  
+
   it "can create an account" do
     xml = File.read(File.dirname(__FILE__) + "/../../../xml/online/account.xml")
     url = @service.url_for_resource(Quickeebooks::Online::Model::Account.resource_for_singular)
@@ -64,24 +59,24 @@ describe "Quickeebooks::Online::Service::Account" do
     result = @service.delete(account)
     result.should == true
   end
-  
+
   it "cannot delete an account with missing required fields for deletion" do
     account = Quickeebooks::Online::Model::Account.new
     lambda { @service.delete(account) }.should raise_error(InvalidModelException, "Missing required parameters for delete")
   end
-  
+
   it "exception is raised when we try to create an invalid account" do
     account = Quickeebooks::Online::Model::Account.new
     lambda { @service.create(account) }.should raise_error(InvalidModelException)
   end
-  
+
   it "can fetch an account by id" do
-    xml = File.read(File.dirname(__FILE__) + "/../../../xml/online/account.xml")
+    xml = onlineFixture("account.xml")
     url = @service.url_for_resource(Quickeebooks::Online::Model::Account.resource_for_singular)
     url = "#{url}/99"
     FakeWeb.register_uri(:get, url, :status => ["200", "OK"], :body => xml)
     account = @service.fetch_by_id(99)
     account.name.should == "Billy Bob"
   end
-  
+
 end

data/spec/quickeebooks/online/services/bill_spec.rb

@@ -0,0 +1,61 @@
+describe "Quickeebooks::Online::Service::Bill" do
+  before(:all) do
+    construct_oauth_service :bill
+  end
+
+  it "can fetch a list of bills" do
+    xml = onlineFixture("bills.xml")
+    url = @service.url_for_resource(Quickeebooks::Online::Model::Bill.resource_for_collection)
+    FakeWeb.register_uri(:post, url, :status => ["200", "OK"], :body => xml)
+    bills = @service.list
+    bills.current_page.should == 1
+    bills.entries.count.should == 1
+    bills.entries.first.header.balance.should == 25.00
+  end
+
+  it "can create a bill" do
+    xml = onlineFixture("bill.xml")
+    url = @service.url_for_resource(Quickeebooks::Online::Model::Bill.resource_for_singular)
+    FakeWeb.register_uri(:post, url, :status => ["200", "OK"], :body => xml)
+    bill = Quickeebooks::Online::Model::Bill.new
+    bill.header = Quickeebooks::Online::Model::BillHeader.new
+    bill.header.total_amount = 25.00
+    result = @service.create(bill)
+    result.id.value.to_i.should > 0
+  end
+
+  it "can delete a bill" do
+    url = "#{@service.url_for_resource(Quickeebooks::Online::Model::Bill.resource_for_singular)}/56"
+    FakeWeb.register_uri(:post, url, :status => ["200", "OK"])
+    bill = Quickeebooks::Online::Model::Bill.new
+    bill.id = Quickeebooks::Online::Model::Id.new("56")
+    bill.sync_token = 0
+    result = @service.delete(bill)
+    result.should == true
+  end
+
+  it "can fetch a bill by id" do
+    xml = onlineFixture("bill.xml")
+    url = "#{@service.url_for_resource(Quickeebooks::Online::Model::Bill.resource_for_singular)}/56"
+    FakeWeb.register_uri(:get, url, :status => ["200", "OK"], :body => xml)
+    bill = @service.fetch_by_id(56)
+    bill.header.total_amount.should == 50
+  end
+
+  it "can update a bill" do
+    xml2 = onlineFixture("bill2.xml")
+    bill = Quickeebooks::Online::Model::Bill.new
+    bill.header = Quickeebooks::Online::Model::BillHeader.new
+    bill.header.total_amount = 75.00 
+    bill.id = Quickeebooks::Online::Model::Id.new("56")
+    bill.sync_token = 2
+
+    url = "#{@service.url_for_resource(Quickeebooks::Online::Model::Bill.resource_for_singular)}/#{bill.id.value}"
+    FakeWeb.register_uri(:post, url, :status => ["200", "OK"], :body => xml2)
+    updated = @service.update(bill)
+    updated.header.total_amount.should == 75.00
+  end
+
+
+end
+

data/spec/quickeebooks/online/services/company_meta_data_spec.rb

@@ -1,8 +1,3 @@
-require "spec_helper"
-require "fakeweb"
-require "oauth"
-require "quickeebooks"
-
 describe "Quickeebooks::Online::Service::CompanyMetaData" do
   before(:all) do
     FakeWeb.allow_net_connect = false
@@ -17,7 +12,7 @@ describe "Quickeebooks::Online::Service::CompanyMetaData" do
         :access_token_path    => "/oauth/v1/get_access_token"
     })
     @oauth = OAuth::AccessToken.new(@oauth_consumer, "blah", "blah")
-    
+
     @service = Quickeebooks::Online::Service::CompanyMetaData.new
     @service.access_token = @oauth
     @service.instance_eval {
@@ -26,7 +21,7 @@ describe "Quickeebooks::Online::Service::CompanyMetaData" do
   end
 
   it "can get the realm's company_meta_data record" do
-    xml = File.read(File.dirname(__FILE__) + "/../../../xml/online/company_meta_data.xml")
+    xml = onlineFixture("company_meta_data.xml")
     url = @service.url_for_resource(Quickeebooks::Online::Model::CompanyMetaData.resource_for_singular)
     FakeWeb.register_uri(:get, url, :status => ["200", "OK"], :body => xml)
     company_meta_data_response = @service.load