quickbooks-ruby 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff4b1233ad85484b5c75b299803783ce7db38148
-  data.tar.gz: d280d02ad5ad234a969568ba7184412a5dc71b00
+  metadata.gz: 8d86d02f5ca0f37bb54251f62fad6ac5f2e6c3ba
+  data.tar.gz: 90261ad5a8722a50537537a8bb22d6e63056a9db
 SHA512:
-  metadata.gz: b3859a045fa2ceed5ef713f7377a9c707738dd3e6430d804a46e12e6a8371eefb14cfb89c6cdb69d6624c93f4f382cdd6078ffb62bbfa2fcbff6a8afbb724550
-  data.tar.gz: 3ce96e27454142e80ab5b7debe74d7da070f5f29794c3d8a53d31a82f5a7c00e8823c50651444bb724c7f9ad2bb7c1a5df0755950b3e27f2fb75b9d63042503f
+  metadata.gz: 7af4121f20483c55b7ff788c10766c511980cf7aa12fde117257b571955c4a60d672062e736e196e061e476debac0f654d0eab4e5112631dd78ea0d4929ebcad
+  data.tar.gz: 2cba0c3f044de53f4f85678f4a9fa24e489c4f662e2533b01fde4d92172e226c7a95813db1e2dcfd3f0c4a409767af96a6f8924fd3792b9aca525a0b9c3f124e

data/lib/quickbooks-ruby.rb

@@ -15,11 +15,14 @@ require 'quickbooks/util/query_builder'
 #== Models
 require 'quickbooks/model/base_model'
 require 'quickbooks/model/base_reference'
+require 'quickbooks/model/document_numbering'
 require 'quickbooks/model/access_token_response'
 require 'quickbooks/model/meta_data'
+require 'quickbooks/model/class'
 require 'quickbooks/model/custom_field'
 require 'quickbooks/model/sales_item_line_detail'
 require 'quickbooks/model/sub_total_line_detail'
+require 'quickbooks/model/department'
 require 'quickbooks/model/discount_line_detail'
 require 'quickbooks/model/discount_override'
 require 'quickbooks/model/payment_line_detail'
@@ -76,8 +79,10 @@ require 'quickbooks/model/batch_response'
 require 'quickbooks/service/service_crud'
 require 'quickbooks/service/base_service'
 require 'quickbooks/service/access_token'
+require 'quickbooks/service/class'
 require 'quickbooks/service/company_info'
 require 'quickbooks/service/customer'
+require 'quickbooks/service/department'
 require 'quickbooks/service/invoice'
 require 'quickbooks/service/item'
 require 'quickbooks/service/sales_receipt'
@@ -112,13 +117,18 @@ module Quickbooks
     end
 
     # set logging on or off
-    attr_writer :log
+    attr_writer :log, :log_xml_pretty_print
 
     # Returns whether to log. Defaults to 'false'.
     def log?
       @log ||= false
     end
 
+    # pretty printing the xml in the logs is "on" by default
+    def log_xml_pretty_print?
+      defined?(@log_xml_pretty_print) ? @log_xml_pretty_print : true
+    end
+
     def log(msg)
       if log?
         logger.info(msg)
@@ -134,7 +144,7 @@ module Quickbooks
   class ServiceUnavailable < StandardError; end
 
   class IntuitRequestException < StandardError
-    attr_accessor :message, :code, :detail, :type
+    attr_accessor :message, :code, :detail, :type, :request_xml
     def initialize(msg)
       self.message = msg
       super(msg)

data/lib/quickbooks/model/account.rb

@@ -34,9 +34,9 @@ module Quickbooks
       xml_accessor :acct_num, :from => 'AcctNum'
       xml_accessor :bank_num, :from => 'BankNum'
 
-      xml_accessor :current_balance, :from => 'CurrentBalance', :as => BigDecimal, :to_xml => Proc.new { |val| val.to_f }
-      xml_accessor :current_balance_with_sub_accounts, :from => 'CurrentBalanceWithSubAccounts', :as => BigDecimal, :to_xml => Proc.new { |val| val.to_f }
-      xml_accessor :opening_balance, :from => 'OpeningBalance', :as => BigDecimal, :to_xml => Proc.new { |val| val.to_f }
+      xml_accessor :current_balance, :from => 'CurrentBalance', :as => BigDecimal, :to_xml => to_xml_big_decimal
+      xml_accessor :current_balance_with_sub_accounts, :from => 'CurrentBalanceWithSubAccounts', :as => BigDecimal, :to_xml => to_xml_big_decimal
+      xml_accessor :opening_balance, :from => 'OpeningBalance', :as => BigDecimal, :to_xml => to_xml_big_decimal
       xml_accessor :opening_balance_date, :from => 'OpeningBalanceDate', :as => DateTime
       xml_accessor :currency_ref, :from => 'CurrencyRef', :as => BaseReference
       xml_accessor :tax_account?, :from => 'TaxAccount'

data/lib/quickbooks/model/account_based_expense_line_detail.rb

@@ -5,11 +5,11 @@ module Quickbooks
       xml_accessor :class_ref, :from => 'ClassRef', :as => BaseReference
       xml_accessor :account_ref, :from => 'AccountRef', :as => BaseReference
       xml_accessor :billable_status, :from => 'BillableStatus'
-      xml_accessor :tax_amount, :from => 'UnitPrice', :as => BigDecimal, :to_xml => Proc.new { |val| val.to_f }
+      xml_accessor :tax_amount, :from => 'UnitPrice', :as => BigDecimal, :to_xml => to_xml_big_decimal
       xml_accessor :tax_code_ref, :from => 'TaxCodeRef', :as => BaseReference
 
       reference_setters :customer_ref, :class_ref, :account_ref, :tax_code_ref
 
     end
   end
-end
+end

data/lib/quickbooks/model/base_model.rb

@@ -41,9 +41,13 @@ module Quickbooks
         HashWithIndifferentAccess[attributes]
       end
 
+      def ensure_line_items_initialization
+        self.line_items ||= []
+      end
+
       class << self
         def to_xml_big_decimal
-          Proc.new { |val| val.to_f unless val.nil? }
+          Proc.new { |val| val.nil? ? nil : val.to_f }
         end
 
         def attribute_names

data/lib/quickbooks/model/bill.rb

@@ -10,6 +10,7 @@ module Quickbooks
       xml_accessor :meta_data, :from => 'MetaData', :as => MetaData
       xml_accessor :doc_number, :from => 'DocNumber'
       xml_accessor :txn_date, :from => 'TxnDate', :as => Date
+      xml_accessor :department_ref, :from => 'DepartmentRef', :as => BaseReference
 
       xml_accessor :line_items, :from => 'Line', :as => [BillLineItem]
 
@@ -30,7 +31,7 @@ module Quickbooks
 
       validates_length_of :line_items, :minimum => 1
 
-      reference_setters :vendor_ref, :payer_ref, :sales_term_ref
+      reference_setters :department_ref, :vendor_ref, :payer_ref, :sales_term_ref
     end
   end
 end

data/lib/quickbooks/model/bill_line_item.rb

@@ -8,7 +8,7 @@ module Quickbooks
       xml_accessor :id, :from => 'Id', :as => Integer
       xml_accessor :line_num, :from => 'LineNum', :as => Integer
       xml_accessor :description, :from => 'Description'
-      xml_accessor :amount, :from => 'Amount', :as => BigDecimal, :to_xml => Proc.new { |val| val.to_f }
+      xml_accessor :amount, :from => 'Amount', :as => BigDecimal, :to_xml => to_xml_big_decimal
       xml_accessor :detail_type, :from => 'DetailType'
 
       #== Various detail types
@@ -20,4 +20,4 @@ module Quickbooks
 
     end
   end
-end
+end

data/lib/quickbooks/model/bill_payment.rb

@@ -23,7 +23,6 @@ module Quickbooks
       ## Required if PayType is CreditCard.
       xml_accessor :credit_card_payment, :from => 'CreditCardPayment', :as => BillPaymentCreditCard
 
-      # readonly
       xml_accessor :total, :from => 'TotalAmt', :as => BigDecimal
 
       validates_length_of :line_items, :minimum => 1

data/lib/quickbooks/model/bill_payment_line_item.rb

@@ -9,7 +9,7 @@ module Quickbooks
       xml_accessor :id, :from => 'Id', :as => Integer
       xml_accessor :line_num, :from => 'LineNum', :as => Integer
       xml_accessor :description, :from => 'Description'
-      xml_accessor :amount, :from => 'Amount', :as => BigDecimal, :to_xml => Proc.new { |val| val.to_f }
+      xml_accessor :amount, :from => 'Amount', :as => BigDecimal, :to_xml => to_xml_big_decimal
       xml_accessor :detail_type, :from => 'DetailType'
 
       xml_accessor :linked_transactions, :from => 'LinkedTxn', :as => [LinkedTransaction]
@@ -18,4 +18,4 @@ module Quickbooks
 
     end
   end
-end
+end

data/lib/quickbooks/model/class.rb

@@ -0,0 +1,31 @@
+module Quickbooks
+  module Model
+    class Class < BaseModel
+      XML_COLLECTION_NODE = "Class"
+      XML_NODE = "Class"
+      REST_RESOURCE = 'class'
+      include NameEntity::Quality
+      include NameEntity::PermitAlterations
+
+      xml_name XML_NODE
+      xml_accessor :id, :from => 'Id', :as => Integer
+      xml_accessor :sync_token, :from => 'SyncToken', :as => Integer
+      xml_accessor :meta_data, :from => 'MetaData', :as => MetaData
+      xml_accessor :name, :from => 'Name'
+      xml_accessor :sub_class, :from => 'SubClass'
+      xml_accessor :parent_ref, :from => 'ParentRef', :as => BaseReference
+      xml_accessor :fully_qualified_name, :from => 'FullyQualifiedName' # ReadOnly
+      xml_accessor :active?, :from => 'Active'
+
+      reference_setters :parent_ref
+
+      #== Validations
+      validate :names_cannot_contain_invalid_characters
+
+      def sub_class?
+        sub_class.to_s == 'true'
+      end
+
+    end
+  end
+end

data/lib/quickbooks/model/credit_memo.rb

@@ -9,7 +9,9 @@ module Quickbooks
       xml_accessor :sync_token, :from => 'SyncToken', :as => Integer
       xml_accessor :meta_data, :from => 'MetaData', :as => MetaData
       xml_accessor :doc_number, :from => 'DocNumber'
-      xml_accessor :placed_on, :from => 'TxnDate', :as => Time
+      #xml_accessor :txn_date, :from => 'TxnDate', :as => Date
+      # TODO: Next major version 'placed_on' should be replaced by 'txn_date'
+      xml_accessor :placed_on, :from => 'TxnDate', :as => Date
 
       xml_accessor :line_items, :from => 'Line', :as => [Line]
 
@@ -30,6 +32,11 @@ module Quickbooks
 
       reference_setters :customer_ref, :sales_term_ref, :deposit_to_account_ref, :payment_method_ref
 
+      def initialize(*args)
+        ensure_line_items_initialization
+        super
+      end
+
       def email=(email)
         self.bill_email = EmailAddress.new(email)
       end

data/lib/quickbooks/model/customer.rb

@@ -42,9 +42,9 @@ module Quickbooks
       xml_accessor :level, :from => 'Level'
       xml_accessor :sales_term_ref, :from => 'SalesTermRef', :as => BaseReference
       xml_accessor :payment_method_ref, :from => 'PaymentMethodRef', :as => BaseReference
-      xml_accessor :balance, :from => 'Balance', :as => BigDecimal, :to_xml => Proc.new { |val| val.to_f }
+      xml_accessor :balance, :from => 'Balance', :as => BigDecimal, :to_xml => to_xml_big_decimal
       xml_accessor :open_balance_date, :from => 'OpenBalanceDate', :as => Date
-      xml_accessor :balance_with_jobs, :from => 'BalanceWithJobs', :as => BigDecimal, :to_xml => Proc.new { |val| val.to_f }
+      xml_accessor :balance_with_jobs, :from => 'BalanceWithJobs', :as => BigDecimal, :to_xml => to_xml_big_decimal
       xml_accessor :preferred_delivery_method, :from => 'PreferredDeliveryMethod'
       xml_accessor :resale_num, :from => 'ResaleNum'
       xml_accessor :suffix, :from => 'Suffix'

data/lib/quickbooks/model/department.rb

@@ -0,0 +1,31 @@
+module Quickbooks
+  module Model
+    class Department < BaseModel
+      XML_COLLECTION_NODE = "Department"
+      XML_NODE = "Department"
+      REST_RESOURCE = 'department'
+      include NameEntity::Quality
+      include NameEntity::PermitAlterations
+
+      xml_name XML_NODE
+      xml_accessor :id, :from => 'Id', :as => Integer
+      xml_accessor :sync_token, :from => 'SyncToken', :as => Integer
+      xml_accessor :meta_data, :from => 'MetaData', :as => MetaData
+      xml_accessor :name, :from => 'Name'
+      xml_accessor :sub_department, :from => 'SubDepartment'
+      xml_accessor :parent_ref, :from => 'ParentRef', :as => BaseReference
+      xml_accessor :fully_qualified_name, :from => 'FullyQualifiedName' # ReadOnly
+      xml_accessor :active?, :from => 'Active'
+
+      reference_setters :parent_ref
+
+      #== Validations
+      validate :names_cannot_contain_invalid_characters
+
+      def sub_department?
+        sub_department.to_s == 'true'
+      end
+
+    end
+  end
+end

data/lib/quickbooks/model/discount_line_detail.rb

@@ -4,7 +4,7 @@ module Quickbooks
     class DiscountLineDetail < BaseModel
       xml_accessor :discount_ref, :from => 'DiscountRef', :as => BaseReference
       xml_accessor :percent_based?, :from => 'PercentBased'
-      xml_accessor :discount_percent, :from => 'DiscountPercent', :as => BigDecimal, :to_xml => Proc.new { |val| val && val.to_f }
+      xml_accessor :discount_percent, :from => 'DiscountPercent', :as => BigDecimal, :to_xml => to_xml_big_decimal
       xml_accessor :discount_account_ref, :from => 'DiscountAccountRef', :as => BaseReference
       xml_accessor :class_ref, :from => 'ClassRef', :as => BaseReference
       xml_accessor :tax_code_ref, :from => 'TaxCodeRef', :as => BaseReference
@@ -12,4 +12,4 @@ module Quickbooks
       reference_setters :tax_code_ref, :class_ref, :discount_ref, :discount_account_ref
     end
   end
-end
+end

data/lib/quickbooks/model/discount_override.rb

@@ -3,7 +3,7 @@ module Quickbooks
     class DiscountOverride < BaseModel
       xml_accessor :discount_ref, :from => 'DiscountRef', :as => BaseReference
       xml_accessor :percent_based?, :from => 'PercentBased'
-      xml_accessor :discount_percent, :from => 'DiscountPercent', :as => BigDecimal, :to_xml => Proc.new { |val| val.to_f }
+      xml_accessor :discount_percent, :from => 'DiscountPercent', :as => BigDecimal, :to_xml => to_xml_big_decimal
       xml_accessor :discount_account_ref, :from => 'DiscountAccountRef', :as => BaseReference
 
       reference_setters :discount_ref, :discount_account_ref

data/lib/quickbooks/model/document_numbering.rb

@@ -0,0 +1,18 @@
+module DocumentNumbering
+
+  # Convenience method for proper AutoDocNumber tag
+  # construction, which should be blank if auto
+  # document numbering is desired.
+  def auto_doc_number!
+    self.auto_doc_number = ''
+  end
+
+  private
+
+  def document_numbering
+    if !auto_doc_number.nil? && !doc_number.nil?
+      errors.add(:doc_number, "DocumentNumber should not be specified if AutoDocNumber is.")
+    end
+  end
+
+end

data/lib/quickbooks/model/employee.rb

@@ -31,7 +31,7 @@ module Quickbooks
       xml_accessor :ssn, :from => 'SSN'
       xml_accessor :address, :from => 'PrimaryAddr', :as => PhysicalAddress
       xml_accessor :billable?, :from => 'BillableTime'
-      xml_accessor :billable_rate, :from => 'BillRate', :as => BigDecimal, :to_xml => Proc.new { |val| val.to_f }
+      xml_accessor :billable_rate, :from => 'BillRate', :as => BigDecimal, :to_xml => to_xml_big_decimal
       xml_accessor :birth_date, :from => 'BirthDate', :as => Date
       xml_accessor :gender, :from => 'Gender'
       xml_accessor :hired_date, :from => 'HiredDate', :as => Date

data/lib/quickbooks/model/estimate.rb

@@ -21,7 +21,7 @@ module Quickbooks
       xml_accessor :doc_number, :from => 'DocNumber'
       xml_accessor :txn_date, :from => 'TxnDate', :as => Date
       xml_accessor :private_note, :from => 'PrivateNote'
-      
+
       xml_accessor :department_ref, :from => 'DepartmentRef', :as => BaseReference
       xml_accessor :linked_transactions, :from => 'LinkedTxn', :as => [LinkedTransaction]
       xml_accessor :line_items, :from => 'Line', :as => [InvoiceLineItem]
@@ -34,10 +34,10 @@ module Quickbooks
       xml_accessor :shipping_address, :from => 'ShipAddr', :as => PhysicalAddress
       xml_accessor :class_ref, :from => 'ClassRef', :as => BaseReference
       xml_accessor :sales_term_ref, :from => 'SalesTermRef', :as => BaseReference
-      xml_accessor :total_amount, :from => 'TotalAmt', :as => BigDecimal, :to_xml => Proc.new { |val| val.to_f }
+      xml_accessor :total_amount, :from => 'TotalAmt', :as => BigDecimal, :to_xml => to_xml_big_decimal
       xml_accessor :ship_method_ref, :from => 'ShipMethodRef', :as => BaseReference
       xml_accessor :ship_date, :from => 'ShipDate', :as => Date
-     
+
       xml_accessor :apply_tax_after_discount?, :from => 'ApplyTaxAfterDiscount'
       xml_accessor :print_status, :from => 'PrintStatus'
       xml_accessor :email_status, :from => 'EmailStatus'
@@ -65,9 +65,6 @@ module Quickbooks
         end
       end
 
-      def ensure_line_items_initialization
-        self.line_items ||= []
-      end
     end
   end
 end

data/lib/quickbooks/model/group_line_detail.rb

@@ -2,10 +2,10 @@ module Quickbooks
   module Model
     class GroupLineDetail < BaseModel
       xml_accessor :group_item_ref, :from => 'CustomerRef', :as => BaseReference
-      xml_accessor :quantity, :from => 'Quantity', :as => BigDecimal, :to_xml => Proc.new { |val| val.to_f }
+      xml_accessor :quantity, :from => 'Quantity', :as => BigDecimal, :to_xml => to_xml_big_decimal
       xml_accessor :line_items, :from => 'Line', :as => [Line]
 
       reference_setters :group_item_ref
     end
   end
-end
+end

data/lib/quickbooks/model/invoice.rb

@@ -19,8 +19,10 @@ module Quickbooks
       xml_accessor :sync_token, :from => 'SyncToken', :as => Integer
       xml_accessor :meta_data, :from => 'MetaData', :as => MetaData
       xml_accessor :custom_fields, :from => 'CustomField', :as => [CustomField]
+      xml_accessor :auto_doc_number, :from => 'AutoDocNumber' # See auto_doc_number! method below for usage
       xml_accessor :doc_number, :from => 'DocNumber'
       xml_accessor :txn_date, :from => 'TxnDate', :as => Date
+      xml_accessor :currency_ref, :from => 'CurrencyRef', :as => BaseReference
       xml_accessor :private_note, :from => 'PrivateNote'
       xml_accessor :linked_transactions, :from => 'LinkedTxn', :as => [LinkedTransaction]
       xml_accessor :line_items, :from => 'Line', :as => [InvoiceLineItem]
@@ -36,12 +38,12 @@ module Quickbooks
       xml_accessor :ship_date, :from => 'ShipDate', :as => Date
       xml_accessor :tracking_num, :from => 'TrackingNum'
       xml_accessor :ar_account_ref, :from => 'ARAccountRef', :as => BaseReference
-      xml_accessor :total_amount, :from => 'TotalAmt', :as => BigDecimal, :to_xml => Proc.new { |val| val.to_f }
+      xml_accessor :total_amount, :from => 'TotalAmt', :as => BigDecimal, :to_xml => to_xml_big_decimal
       xml_accessor :apply_tax_after_discount?, :from => 'ApplyTaxAfterDiscount'
       xml_accessor :print_status, :from => 'PrintStatus'
       xml_accessor :email_status, :from => 'EmailStatus'
-      xml_accessor :balance, :from => 'Balance', :as => BigDecimal, :to_xml => Proc.new { |val| val.to_f }
-      xml_accessor :deposit, :from => 'Deposit', :as => BigDecimal, :to_xml => Proc.new { |val| val.to_f }
+      xml_accessor :balance, :from => 'Balance', :as => BigDecimal, :to_xml => to_xml_big_decimal
+      xml_accessor :deposit, :from => 'Deposit', :as => BigDecimal, :to_xml => to_xml_big_decimal
       xml_accessor :department_ref, :from => 'DepartmentRef', :as => BaseReference
       xml_accessor :allow_ipn_payment?, :from => 'AllowIPNPayment'
       xml_accessor :bill_email, :from => 'BillEmail', :as => EmailAddress
@@ -49,13 +51,15 @@ module Quickbooks
       xml_accessor :allow_online_credit_card_payment?, :from => 'AllowOnlineCreditCardPayment'
       xml_accessor :allow_online_ach_payment?, :from => 'AllowOnlineACHPayment'
 
+      include DocumentNumbering
       reference_setters :customer_ref, :class_ref, :sales_term_ref, :ship_method_ref
-      reference_setters :ar_account_ref, :department_ref, :ar_account_ref
+      reference_setters :ar_account_ref, :department_ref, :ar_account_ref, :currency_ref
 
       #== Validations
       validates_length_of :line_items, :minimum => 1
       validate :existence_of_customer_ref
       validate :required_bill_email_if_email_delivery
+      validate :document_numbering
 
       def initialize(*args)
         ensure_line_items_initialization
@@ -74,6 +78,7 @@ module Quickbooks
         self.bill_email = EmailAddress.new(email_address_string)
       end
 
+
       def wants_billing_email_sent!
         self.email_status = EMAIL_STATUS_NEED_TO_SEND
       end
@@ -82,7 +87,6 @@ module Quickbooks
         email_status == EMAIL_STATUS_NEED_TO_SEND
       end
 
-      private
 
       def existence_of_customer_ref
         if customer_ref.nil? || (customer_ref && customer_ref.value == 0)
@@ -90,9 +94,6 @@ module Quickbooks
         end
       end
 
-      def ensure_line_items_initialization
-        self.line_items ||= []
-      end
     end
   end
 end

data/lib/quickbooks/model/invoice_line_item.rb

@@ -11,7 +11,7 @@ module Quickbooks
       xml_accessor :id, :from => 'Id', :as => Integer
       xml_accessor :line_num, :from => 'LineNum', :as => Integer
       xml_accessor :description, :from => 'Description'
-      xml_accessor :amount, :from => 'Amount', :as => BigDecimal, :to_xml => Proc.new { |val| val.to_f }
+      xml_accessor :amount, :from => 'Amount', :as => BigDecimal, :to_xml => to_xml_big_decimal
       xml_accessor :detail_type, :from => 'DetailType'
 
       #== Various detail types
@@ -55,4 +55,4 @@ module Quickbooks
 
     end
   end
-end
+end