quickbooks-ruby 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff8e60580cbdc70768e250a4adf0eb56f8a2738b
-  data.tar.gz: e895d50078ed86a143b9efa9d8607daa2bcb39be
+  metadata.gz: 2551f351313de20062141ecefecb34d978593a27
+  data.tar.gz: 812f7319325c66eea93175963e5dfcc90a27c10d
 SHA512:
-  metadata.gz: ce775c53ea29e7d9b090311b0aa63d4cf110b09d4b87e3e291c99e1494de249e30b79bfd58e3a9d43b0c7ccc3e7ccdd926e6a596e5a2298968fe5d996dda188b
-  data.tar.gz: 1898cbab1fe4a946d83cf37cc3dd843fd89d95f8af3d5554872ee059fa2b6354aa043bb01ffdd36925c2d5f981f7b75d4e4555d3583f9c626479d0100c6d3d27
+  metadata.gz: cee4a16a48605113b8abf11127a6acb09463ce13e0cfa1bd2fa28d8195f658cce2944b534dd0a08cc96584199d45b14408e37c932062e4ff676203e373d50821
+  data.tar.gz: c10ccc62ea309b00eb521b459738b51a16834031a13f57021e4b32a4bfb04aca2974b15ea394f556c4642fd448eec91556fce84e807545f71332d75cb044a143

data/lib/{quickbooks.rb → quickbooks-ruby.rb}

@@ -8,19 +8,24 @@ require 'date'
 require 'forwardable'
 require 'oauth'
 require 'quickbooks/util/logging'
+require 'quickbooks/util/class_util'
+require 'quickbooks/util/http_encoding_helper'
 
 #== Models
 require 'quickbooks/model/base_model'
+require 'quickbooks/model/base_reference'
 require 'quickbooks/model/meta_data'
 require 'quickbooks/model/custom_field'
-require 'quickbooks/model/invoice_item_ref'
 require 'quickbooks/model/sales_item_line_detail'
 require 'quickbooks/model/sub_total_line_detail'
-require 'quickbooks/model/customer_ref'
 require 'quickbooks/model/discount_override'
 require 'quickbooks/model/payment_line_detail'
+require 'quickbooks/model/account_based_expense_line_detail'
+require 'quickbooks/model/line'
 require 'quickbooks/model/item'
-
+require 'quickbooks/model/account'
+require 'quickbooks/model/check_payment'
+require 'quickbooks/model/credit_card_payment'
 
 require 'quickbooks/model/telephone_number'
 require 'quickbooks/model/email_address'
@@ -30,6 +35,15 @@ require 'quickbooks/model/linked_transaction'
 require 'quickbooks/model/invoice_line_item'
 require 'quickbooks/model/invoice'
 require 'quickbooks/model/customer'
+require 'quickbooks/model/sales_receipt'
+require 'quickbooks/model/payment_method'
+require 'quickbooks/model/credit_memo'
+require 'quickbooks/model/bill_line_item'
+require 'quickbooks/model/bill'
+require 'quickbooks/model/bill_payment_line_item'
+require 'quickbooks/model/bill_payment_check'
+require 'quickbooks/model/bill_payment_credit_card'
+require 'quickbooks/model/bill_payment'
 
 #== Services
 require 'quickbooks/service/base_service'
@@ -37,8 +51,16 @@ require 'quickbooks/service/service_crud'
 require 'quickbooks/service/customer'
 require 'quickbooks/service/invoice'
 require 'quickbooks/service/item'
+require 'quickbooks/service/sales_receipt'
+require 'quickbooks/service/account'
+require 'quickbooks/service/payment_method'
+require 'quickbooks/service/credit_memo'
+require 'quickbooks/service/bill'
+require 'quickbooks/service/bill_payment'
 
-class InvalidModelException < StandardError; end
+unless Quickbooks::Util::ClassUtil.defined?("InvalidModelException")
+  class InvalidModelException < StandardError; end
+end
 
 module Quickbooks
   @@logger = nil

data/lib/quickbooks/model/account.rb

@@ -0,0 +1,91 @@
+module Quickbooks
+  module Model
+    class Account < BaseModel
+      XML_COLLECTION_NODE = "Account"
+      XML_NODE = "Account"
+      REST_RESOURCE = 'account'
+
+      ASSET = 'Asset'
+      EQUITY = 'Equity'
+      EXPENSE = 'Expense'
+      LIABILITY = 'Liability'
+      REVENUE = 'Revenue'
+
+      ACCOUNT_CLASSIFICATION = [ASSET, EQUITY, EXPENSE, LIABILITY, REVENUE]
+
+      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 :has_attachment, :from => 'HasAttachment'
+      xml_accessor :name, :from => 'Name'
+      xml_accessor :description, :from => 'Description'
+
+      xml_accessor :sub_account, :from => 'SubAccount'
+      xml_accessor :parent_ref, :from => 'ParentRef', :as => BaseReference
+
+      xml_accessor :active, :from => 'Active'
+
+      xml_accessor :classification, :from => 'Classification'
+      xml_accessor :account_type, :from => 'AccountType'
+      xml_accessor :account_sub_type, :from => 'AccountSubType'
+
+      xml_accessor :acct_num, :from => 'AcctNum'
+      xml_accessor :bank_num, :from => 'BankNum'
+
+      xml_accessor :opening_balance, :from => 'OpeningBalance', :as => BigDecimal, :to_xml => Proc.new { |val| val.to_f }
+      xml_accessor :opening_balance_date, :from => 'OpeningBalanceDate', :as => DateTime
+      xml_accessor :currency_ref, :from => 'CurrencyRef', :as => BaseReference
+      xml_accessor :tax_account, :from => 'TaxAccount'
+      xml_accessor :tax_code_ref, :from => 'TaxCodeRef', :as => BaseReference
+
+      reference_setters :parent_ref, :currency_ref, :tax_code_ref
+
+      #== Validations
+      validates_inclusion_of :classification, :in => ACCOUNT_CLASSIFICATION
+      validates_length_of :name, :minimum => 1, :maximum => 100
+      validates_length_of :description, :minimum => 1, :maximum => 100
+      validate :name_cannot_contain_invalid_characters
+
+      def name_cannot_contain_invalid_characters
+        if name && (name.index(':') || name.index('"'))
+          errors.add('name', ":#{name} cannot contain a colon (:) or double quotes (\").")
+        end
+      end
+
+      def valid_for_update?
+        if sync_token.nil?
+          errors.add(:sync_token, "Missing required attribute SyncToken for update")
+        end
+        errors.empty?
+      end
+
+      def valid_for_create?
+        valid?
+        errors.empty?
+      end
+
+      def valid_for_deletion?
+        return false if(id.nil? || sync_token.nil?)
+        id.to_i > 0 && !sync_token.to_s.empty? && sync_token.to_i >= 0
+      end
+
+      def has_attachment?
+        has_attachment.to_s == 'true'
+      end
+
+      def sub_account?
+        sub_account.to_s == 'true'
+      end
+
+      def active?
+        active.to_s == 'true'
+      end
+
+      def tax_account?
+        tax_account.to_s == 'true'
+      end
+    end
+  end
+end

data/lib/quickbooks/model/account_based_expense_line_detail.rb

@@ -0,0 +1,15 @@
+module Quickbooks
+  module Model
+    class AccountBasedExpenseLineDetail < BaseModel
+      xml_accessor :customer_ref, :from => 'CustomerRef', :as => BaseReference
+      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_code_ref, :from => 'TaxCodeRef', :as => BaseReference
+
+      reference_setters :customer_ref, :class_ref, :account_ref, :tax_code_ref
+
+    end
+  end
+end

data/lib/quickbooks/model/base_model.rb

@@ -35,6 +35,27 @@ module Quickbooks
           self::REST_RESOURCE
         end
 
+        # Automatically generate an ID setter.
+        # Example:
+        #   reference_setters :discount_ref
+        # Would generate a method like:
+        # def discount_id=(id)
+        #    self.discount_ref = BaseReference.new(id)
+        # end
+        def reference_setters(*args)
+          args.each do |attribute|
+            method_name = "#{attribute.to_s.gsub('_ref', '_id')}=".to_sym
+            unless instance_methods(false).include?(method_name)
+              method_definition = <<-METH
+              def #{method_name}(id)
+                self.#{attribute} = BaseReference.new(id)
+              end
+              METH
+              class_eval(method_definition)
+            end
+          end
+        end
+
       end
     end
   end

data/lib/quickbooks/model/{customer_ref.rb → base_reference.rb}

@@ -1,6 +1,6 @@
 module Quickbooks
   module Model
-    class CustomerRef < BaseModel
+    class BaseReference < BaseModel
       xml_convention :camelcase
       xml_accessor :name, :from => '@name' # Attribute with name 'name'
       xml_accessor :value, :from => :content

data/lib/quickbooks/model/bill.rb

@@ -0,0 +1,36 @@
+module Quickbooks
+  module Model
+    class Bill < BaseModel
+      XML_COLLECTION_NODE = "Bill"
+      XML_NODE = "Bill"
+      REST_RESOURCE = 'bill'
+
+      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 :doc_number, :from => 'DocNumber'
+      xml_accessor :txn_date, :from => 'TxnDate', :as => Date
+
+      xml_accessor :line_items, :from => 'Line', :as => [BillLineItem]
+
+      xml_accessor :private_note, :from => 'PrivateNote'
+
+      xml_accessor :vendor_ref, :from => 'VendorRef', :as => BaseReference
+      xml_accessor :payer_ref, :from => 'PayerRef', :as => BaseReference
+      xml_accessor :sales_term_ref, :from => 'SalesTermRef', :as => BaseReference
+
+      xml_accessor :due_date, :from => 'DueDate', :as => Date
+      xml_accessor :remit_to_address, :from => 'RemitToAddr', :as => PhysicalAddress
+      xml_accessor :ship_address, :from => 'ShipAddr', :as => PhysicalAddress
+
+      # readonly
+      xml_accessor :bill_email, :from => 'BillEmail', :as => EmailAddress
+      xml_accessor :reply_email, :from => 'ReplyEmail', :as => EmailAddress
+      xml_accessor :total, :from => 'TotalAmt', :as => BigDecimal
+
+      validates_length_of :line_items, :minimum => 1
+
+      reference_setters :vendor_ref, :payer_ref, :sales_term_ref
+    end
+  end
+end

data/lib/quickbooks/model/bill_line_item.rb

@@ -0,0 +1,23 @@
+module Quickbooks
+  module Model
+    class BillLineItem < BaseModel
+
+      #== Constants
+      ACCOUNT_BASED_EXPENSE_LINE_DETAIL = 'AccountBasedExpenseLineDetail'
+
+      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 :detail_type, :from => 'DetailType'
+
+      #== Various detail types
+      xml_accessor :account_based_expense_line_detail, :from => 'AccountBasedExpenseLineDetail', :as => AccountBasedExpenseLineDetail
+
+      def account_based_expense_item?
+        detail_type.to_s == ACCOUNT_BASED_EXPENSE_LINE_DETAIL
+      end
+
+    end
+  end
+end

data/lib/quickbooks/model/bill_payment.rb

@@ -0,0 +1,34 @@
+module Quickbooks
+  module Model
+    class BillPayment < BaseModel
+      XML_COLLECTION_NODE = "BillPayment"
+      XML_NODE = "BillPayment"
+      REST_RESOURCE = 'bill_payment'
+
+      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 :doc_number, :from => 'DocNumber'
+      xml_accessor :txn_date, :from => 'TxnDate', :as => Date
+
+      xml_accessor :line_items, :from => 'Line', :as => [BillPaymentLineItem]
+
+      xml_accessor :private_note, :from => 'PrivateNote'
+
+      xml_accessor :vendor_ref, :from => 'VendorRef', :as => BaseReference
+      xml_accessor :pay_type, :from => 'PayType'
+
+      ## Required if PayType is Check.
+      xml_accessor :check_payment, :from => 'CheckPayment', :as => BillPaymentCheck
+      ## 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
+
+      reference_setters :vendor_ref
+    end
+  end
+end

data/lib/quickbooks/model/bill_payment_check.rb

@@ -0,0 +1,12 @@
+module Quickbooks
+  module Model
+    class BillPaymentCheck < BaseModel
+      xml_accessor :bank_account_ref, :from => 'BankAccountRef', :as => BaseReference
+      xml_accessor :print_status, :from => 'PrintStatus'
+      xml_accessor :check_detail, :from => 'CheckDetail', :as => CheckPayment
+      xml_accessor :payee_address, :from => 'PayeeAddr', :as => PhysicalAddress
+
+      reference_setters :bank_account_ref
+    end
+  end
+end

data/lib/quickbooks/model/bill_payment_credit_card.rb

@@ -0,0 +1,10 @@
+module Quickbooks
+  module Model
+    class BillPaymentCreditCard < BaseModel
+      xml_accessor :cc_account_ref, :from => 'CCAccountRef', :as => BaseReference
+      xml_accessor :cc_detail, :from => 'CCDetail', :as => CreditCardPayment
+
+      reference_setters :cc_account_ref
+    end
+  end
+end

data/lib/quickbooks/model/bill_payment_line_item.rb

@@ -0,0 +1,21 @@
+module Quickbooks
+  module Model
+    class BillPaymentLineItem < BaseModel
+
+      #== Constants
+      PAYMENT_LINE_DETAIL = 'PaymentLineDetail'
+      DISCOUNT_LINE_DETAIL = 'DiscountLineDetail'
+
+      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 :detail_type, :from => 'DetailType'
+
+      xml_accessor :linked_transactions, :from => 'LinkedTxn', :as => [LinkedTransaction]
+
+      #== Various detail types
+
+    end
+  end
+end

data/lib/quickbooks/model/check_payment.rb

@@ -0,0 +1,11 @@
+module Quickbooks
+  module Model
+    class CheckPayment < BaseModel
+      xml_accessor :check_number, :from => 'CheckNum'
+      xml_accessor :status, :from => 'Status'
+      xml_accessor :name_on_account, :from => 'NameOnAcct'
+      xml_accessor :account_number, :from => 'AcctNum'
+      xml_accessor :bank_name, :from => 'BankName'
+    end
+  end
+end

data/lib/quickbooks/model/credit_card_payment.rb

@@ -0,0 +1,17 @@
+module Quickbooks
+  module Model
+    class CreditCardPayment < BaseModel
+      xml_accessor :number, :from => 'Number'
+      xml_accessor :type, :from => 'Type'
+      xml_accessor :name_on_account, :from => 'NameOnAcct'
+      xml_accessor :expiry_month, :from => 'CcExpiryMonth', :as => Integer
+      xml_accessor :expiry_year, :from => 'CcExpiryYear', :as => Integer
+      xml_accessor :bill_address, :from => 'BillAddrStreet'
+      xml_accessor :postal_code, :from => 'PostalCode'
+      xml_accessor :commercial_card_code, :from => 'CommercialCardCode'
+      xml_accessor :txn_mode, :from => 'CCTxnMode'
+      xml_accessor :txn_type, :from => 'CCTxnType'
+      xml_accessor :previous_txn_id, :from => 'PrevCCTransId'
+    end
+  end
+end

data/lib/quickbooks/model/credit_memo.rb

@@ -0,0 +1,38 @@
+module Quickbooks
+  module Model
+    class CreditMemo < BaseModel
+      XML_COLLECTION_NODE = "CreditMemo"
+      XML_NODE = "CreditMemo"
+      REST_RESOURCE = 'creditmemo'
+
+      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 :doc_number, :from => 'DocNumber'
+      xml_accessor :placed_on, :from => 'TxnDate', :as => Time
+
+      xml_accessor :line_items, :from => 'Line', :as => [Line]
+
+      xml_accessor :private_note, :from => 'PrivateNote'
+
+      xml_accessor :customer_ref, :from => 'CustomerRef', :as => BaseReference
+      xml_accessor :customer_memo, :from => 'CustomerMemo'
+      xml_accessor :bill_email, :from => 'BillEmail', :as => EmailAddress
+      xml_accessor :bill_address, :from => 'BillAddr', :as => PhysicalAddress
+      xml_accessor :sales_term_ref, :from => 'SalesTermRef', :as => BaseReference
+      xml_accessor :deposit_to_account_ref, :from => 'DepositToAccountRef', :as => BaseReference
+      xml_accessor :payment_method_ref, :from => 'PaymentMethodRef', :as => BaseReference
+
+      # readonly
+      xml_accessor :total, :from => 'TotalAmt', :as => BigDecimal
+
+      validates_length_of :line_items, :minimum => 1
+
+      reference_setters :customer_ref, :sales_term_ref, :deposit_to_account_ref, :payment_method_ref
+
+      def email=(email)
+        self.bill_email = EmailAddress.new(email)
+      end
+    end
+  end
+end

data/lib/quickbooks/model/customer.rb

@@ -17,7 +17,7 @@ module Quickbooks
       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 => Quickbooks::Model::MetaData
+      xml_accessor :meta_data, :from => 'MetaData', :as => MetaData
       xml_accessor :title, :from => 'Title'
       xml_accessor :given_name, :from => 'GivenName'
       xml_accessor :middle_name, :from => 'MiddleName'
@@ -26,23 +26,23 @@ module Quickbooks
       xml_accessor :display_name, :from => 'DisplayName'
       xml_accessor :print_on_check_name, :from => 'PrintOnCheckName'
       xml_accessor :active, :from => 'Active'
-      xml_accessor :primary_phone, :from => 'PrimaryPhone', :as => Quickbooks::Model::TelephoneNumber
-      xml_accessor :alternate_phone, :from => 'AlternatePhone', :as => Quickbooks::Model::TelephoneNumber
-      xml_accessor :mobile_phone, :from => 'Mobile', :as => Quickbooks::Model::TelephoneNumber
-      xml_accessor :fax_phone, :from => 'Fax', :as => Quickbooks::Model::TelephoneNumber
-      xml_accessor :primary_email_address, :from => 'PrimaryEmailAddr', :as => Quickbooks::Model::EmailAddress
-      xml_accessor :web_site, :from => 'WebAddr', :as => Quickbooks::Model::WebSiteAddress
-      xml_accessor :billing_address, :from => 'BillAddr', :as => Quickbooks::Model::PhysicalAddress
-      xml_accessor :shipping_address, :from => 'ShipAddr', :as => Quickbooks::Model::PhysicalAddress
+      xml_accessor :primary_phone, :from => 'PrimaryPhone', :as => TelephoneNumber
+      xml_accessor :alternate_phone, :from => 'AlternatePhone', :as => TelephoneNumber
+      xml_accessor :mobile_phone, :from => 'Mobile', :as => TelephoneNumber
+      xml_accessor :fax_phone, :from => 'Fax', :as => TelephoneNumber
+      xml_accessor :primary_email_address, :from => 'PrimaryEmailAddr', :as => EmailAddress
+      xml_accessor :web_site, :from => 'WebAddr', :as => WebSiteAddress
+      xml_accessor :billing_address, :from => 'BillAddr', :as => PhysicalAddress
+      xml_accessor :shipping_address, :from => 'ShipAddr', :as => PhysicalAddress
       xml_accessor :job, :from => 'Job'
       xml_accessor :bill_with_parent, :from => 'BillWithParent'
-      xml_accessor :parent_ref, :from => 'ParentRef', :as => Integer
+      xml_accessor :parent_ref, :from => 'ParentRef', :as => BaseReference
       xml_accessor :level, :from => 'Level'
-      xml_accessor :sales_term_ref, :from => 'SalesTermRef', :as => Integer
-      xml_accessor :payment_method_ref, :from => 'PaymentMethodRef'
-      xml_accessor :balance, :from => 'Balance', :as => Float
+      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 :open_balance_date, :from => 'OpenBalanceDate', :as => Date
-      xml_accessor :balance_with_jobs, :from => 'BalanceWithJobs', :as => Float
+      xml_accessor :balance_with_jobs, :from => 'BalanceWithJobs', :as => BigDecimal, :to_xml => Proc.new { |val| val.to_f }
       xml_accessor :preferred_delivery_method, :from => 'PreferredDeliveryMethod'
       xml_accessor :resale_num, :from => 'ResaleNum'
       xml_accessor :suffix, :from => 'Suffix'
@@ -50,9 +50,12 @@ module Quickbooks
       xml_accessor :taxable, :from => 'Taxable'
       xml_accessor :notes, :from => 'Notes'
 
+      #== Validations
       validate :names_cannot_contain_invalid_characters
       validate :email_address_is_valid
 
+      reference_setters :parent_ref, :sales_term_ref, :payment_method_ref
+
       def active?
         active.to_s == 'true'
       end
@@ -82,7 +85,7 @@ module Quickbooks
       end
 
       def email_address=(email_address)
-        self.primary_email_address = Quickbooks::Model::EmailAddress.new(email_address)
+        self.primary_email_address = EmailAddress.new(email_address)
       end
 
       def email_address