quickeebooks 0.0.3 → 0.0.4

data/lib/quickeebooks/online/model/invoice_header.rb

@@ -11,8 +11,9 @@ module Quickeebooks
         xml_accessor :doc_number, :from => 'DocNumber'
         xml_accessor :txn_date, :from => 'TxnDate', :as => Time
         xml_accessor :msg, :from => 'Msg'
-        xml_accessor :customer_id, :from => 'CustomerId'
-        xml_accessor :sales_tax_code_id, :from => 'SalesTaxCodeId'
+        xml_accessor :customer_id, :from => 'CustomerId', :as => Quickeebooks::Online::Model::Id
+        xml_accessor :customer_name, :from => 'CustomerName'
+        xml_accessor :sales_tax_code_id, :from => 'SalesTaxCodeId', :as => Quickeebooks::Online::Model::Id
         xml_accessor :sales_tax_code_name, :from => 'SalesTaxCodeName'
         xml_accessor :sub_total_amount, :from => 'SubTotalAmt', :as => Float
         xml_accessor :tax_rate, :from => 'TaxRate', :as => Float
@@ -22,6 +23,7 @@ module Quickeebooks
         xml_accessor :discount_amount, :from => 'DiscountAmt', :as => Float
         xml_accessor :status, :from => 'Status'
         xml_accessor :ship_date, :from => 'ShipDate', :as => Time
+        xml_accessor :to_be_emailed, :from => 'ToBeEmailed'
       end
     end
   end

data/lib/quickeebooks/online/model/invoice_line_item.rb

@@ -1,19 +1,20 @@
-module Quickeebooks
+require 'quickeebooks/online/model/id'
 
+module Quickeebooks
   module Online
     module Model
       class InvoiceLineItem < Quickeebooks::Online::Model::IntuitType
         xml_name 'Line'
-        xml_accessor :id, :from => 'Id'
+        xml_accessor :id, :from => 'Id', :as => Quickeebooks::Online::Model::Id
         xml_accessor :desc, :from => 'Desc'
         xml_accessor :amount, :from => 'Amount', :as => Float
-        xml_accessor :class_id, :from => 'ClassId'
+        xml_accessor :class_id, :from => 'ClassId', :as => Quickeebooks::Online::Model::Id
         xml_accessor :taxable, :from => 'Taxable'
-        xml_accessor :item_id, :from => 'ItemId'
+        xml_accessor :item_id, :from => 'ItemId', :as => Quickeebooks::Online::Model::Id
         xml_accessor :unit_price, :from => 'UnitPrice', :as => Float
         xml_accessor :quantity, :from => 'Qty', :as => Float
-        xml_accessor :override_item_account_id, :from => 'OverrideItemAccountId'
-        xml_accessor :sales_tax_code_id, :from => 'SalesTaxCodeId'
+        xml_accessor :override_item_account_id, :from => 'OverrideItemAccountId', :as => Quickeebooks::Online::Model::Id
+        xml_accessor :sales_tax_code_id, :from => 'SalesTaxCodeId', :as => Quickeebooks::Online::Model::Id
         xml_accessor :sales_tax_code_name, :from => 'SalesTaxCodeName'
         xml_accessor :service_date, :from => 'ServiceDate', :as => Time
       end

data/lib/quickeebooks/online/model/item.rb

@@ -1,4 +1,5 @@
 require 'time'
+require "quickeebooks/online/model/id"
 require 'quickeebooks/online/model/price'
 require 'quickeebooks/online/model/meta_data'
 require 'quickeebooks/online/model/account_reference'
@@ -9,12 +10,17 @@ module Quickeebooks
     module Model
       class Item < Quickeebooks::Online::Model::IntuitType
         include ActiveModel::Validations
+        
+        XML_NODE = "Item"
+        
+        # <baseURL>/resource/items/v2/<realmID>
+        REST_RESOURCE = "items"
 
         xml_name 'Item'
-        xml_accessor :id, :from => 'Id'
+        xml_accessor :id, :from => 'Id', :as => Quickeebooks::Online::Model::Id
         xml_accessor :sync_token, :from => 'SyncToken', :as => Integer
         xml_accessor :meta_data, :from => 'MetaData', :as => Quickeebooks::Online::Model::MetaData
-        xml_accessor :item_parent_id, :from => 'ItemParentId'
+        xml_accessor :item_parent_id, :from => 'ItemParentId', :as => Quickeebooks::Online::Model::Id
         xml_accessor :item_parent_name, :from => 'ItemParentName'
         xml_accessor :name, :from => 'Name'
         xml_accessor :desc, :from => 'Desc'

data/lib/quickeebooks/online/model/payment.rb

@@ -0,0 +1,58 @@
+require 'quickeebooks/online/model/payment_header'
+require 'quickeebooks/online/model/payment_line_item'
+require 'quickeebooks/online/model/payment_detail'
+require 'quickeebooks/online/model/credit_card'
+require 'quickeebooks/online/model/credit_charge_info'
+require 'quickeebooks/online/model/credit_charge_response'
+require 'quickeebooks/online/model/meta_data'
+
+module Quickeebooks
+  module Online
+    module Model
+      class Payment  < Quickeebooks::Online::Model::IntuitType
+        XML_NODE = "Payment"
+        REST_RESOURCE = "payment"
+
+        include ActiveModel::Validations
+        xml_convention :camelcase
+        xml_accessor :id,         :from => 'Id',        :as => Quickeebooks::Online::Model::Id
+        xml_accessor :sync_token, :from => 'SyncToken', :as => Integer
+        xml_accessor :meta_data,  :from => 'MetaData',  :as => Quickeebooks::Online::Model::MetaData
+        xml_accessor :header,     :from => 'Header',    :as => Quickeebooks::Online::Model::PaymentHeader
+        xml_accessor :line_items, :from => 'Line',      :as => [Quickeebooks::Online::Model::PaymentLineItem]
+
+        def initialize
+          ensure_line_items_initialization
+        end
+
+        def valid_for_update?
+          errors.empty?
+        end        
+
+        def to_xml_ns(options = {})
+          to_xml_inject_ns(XML_NODE, options)
+        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
+        
+        #== Class methods
+        def self.resource_for_collection
+          "#{self::REST_RESOURCE}s"
+        end
+
+        private
+
+        def after_parse
+        end
+
+        def ensure_line_items_initialization
+          self.line_items ||= []
+        end
+
+      end
+    end
+  end
+end

data/lib/quickeebooks/online/model/payment_detail.rb

@@ -0,0 +1,12 @@
+require 'quickeebooks/online/model/credit_card'
+
+module Quickeebooks
+  module Online
+    module Model
+      class PaymentDetail  < Quickeebooks::Online::Model::IntuitType
+        xml_name 'Detail'
+        xml_accessor :credit_card, :from => 'CreditCard', :as => Quickeebooks::Online::Model::CreditCard
+      end
+    end
+  end
+end

data/lib/quickeebooks/online/model/payment_header.rb

@@ -0,0 +1,24 @@
+require 'time'
+require 'quickeebooks/online/model/payment_detail'
+
+module Quickeebooks
+  module Online
+    module Model
+      class PaymentHeader < Quickeebooks::Online::Model::IntuitType
+        xml_name 'Header'
+        xml_accessor :doc_number,            :from => 'DocNumber'
+        xml_accessor :txn_date,              :from => 'TxnDate',           :as => Time
+        xml_accessor :note,                  :from => 'Note'
+        xml_accessor :status,                :from => 'Status'
+        xml_accessor :customer_id,           :from => 'CustomerId',        :as => Quickeebooks::Online::Model::Id
+        xml_accessor :customer_name,         :from => 'CustomerName'
+        xml_accessor :deposit_to_account_id, :from => 'DepositToAccountId', :as => Quickeebooks::Online::Model::Id
+        xml_accessor :payment_method_id,     :from => 'PaymentMethodId',    :as => Quickeebooks::Online::Model::Id
+        xml_accessor :payment_method_name,   :from => 'PaymentMethodName'
+        xml_accessor :detail,                :from => 'Detail',           :as => Quickeebooks::Online::Model::PaymentDetail
+        xml_accessor :total_amount,          :from => 'TotalAmt',         :as => Float
+        xml_accessor :process_payment,       :from => 'ProcessPayment'
+      end
+    end
+  end
+end

data/lib/quickeebooks/online/model/payment_line_item.rb

@@ -0,0 +1,15 @@
+require 'quickeebooks/online/model/id'
+
+module Quickeebooks 
+  module Online 
+    module Model
+      class PaymentLineItem < Quickeebooks::Online::Model::IntuitType
+        xml_name 'Line'
+        xml_accessor :id,         :from => 'Id',        :as => Integer
+        xml_accessor :amount,     :from => 'Amount',    :as => Float
+        xml_accessor :desc,       :from => 'Desc'
+        xml_accessor :txn_id,     :from => 'TxnId', :as => Quickeebooks::Online::Model::Id
+      end
+    end
+  end
+end

data/lib/quickeebooks/online/service/account.rb

@@ -7,13 +7,13 @@ module Quickeebooks
       class Account < ServiceBase
 
         def list(filters = [], page = 1, per_page = 20, sort = nil, options = {})
-          fetch_collection("accounts", "Account", Quickeebooks::Online::Model::Account, filters, page, per_page, sort, options)
+          fetch_collection(Quickeebooks::Online::Model::Account, filters, page, per_page, sort, options)
         end
 
         def create(account)
           raise InvalidModelException unless account.valid?
           xml = account.to_xml_ns
-          response = do_http_post(url_for_resource("account"), valid_xml_document(xml))
+          response = do_http_post(url_for_resource(Quickeebooks::Online::Model::Account.resource_for_singular), valid_xml_document(xml))
           if response && response.code.to_i == 200
             Quickeebooks::Online::Model::Account.from_xml(response.body)
           else
@@ -24,7 +24,7 @@ module Quickeebooks
         def update(account)
           raise InvalidModelException unless account.valid_for_update?
           xml = account.to_xml_ns
-          url = "#{url_for_resource("account")}/#{account.id}"
+          url = "#{url_for_resource(Quickeebooks::Online::Model::Account.resource_for_singular)}/#{account.id}"
           response = do_http_post(url, valid_xml_document(xml))
           if response && response.code.to_i == 200
             Quickeebooks::Online::Model::Account.from_xml(response.body)
@@ -34,14 +34,14 @@ module Quickeebooks
         end
 
         def fetch_by_id(account_id)
-          response = do_http_get("#{url_for_resource("account")}/#{account_id}")
+          response = do_http_get("#{url_for_resource(Quickeebooks::Online::Model::Account.resource_for_singular)}/#{account_id}")
           Quickeebooks::Online::Model::Account.from_xml(response.body)
         end
 
         def delete(account)
           raise InvalidModelException.new("Missing required parameters for delete") unless account.valid_for_deletion?
           xml = valid_xml_document(account.to_xml_ns(:fields => ['Id', 'SyncToken']))
-          url = "#{url_for_resource("account")}/#{account.id}"
+          url = "#{url_for_resource(Quickeebooks::Online::Model::Account.resource_for_singular)}/#{account.id}"
           response = do_http_post(url, xml, {:methodx => "delete"})
           response.code.to_i == 200
         end

data/lib/quickeebooks/online/service/company_meta_data.rb

@@ -0,0 +1,24 @@
+require 'quickeebooks/online/service/service_base'
+require 'nokogiri'
+
+module Quickeebooks
+  module Online
+    module Service
+      # read only, corresponds to the realm_id
+      # see https://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0050_Data_Services/0400_QuickBooks_Online/CompanyMetaData
+      class CompanyMetaData < ServiceBase
+
+        def load
+          url = url_for_resource(Quickeebooks::Online::Model::CompanyMetaData.resource_for_singular)
+          response = do_http_get(url)
+          if response && response.code.to_i == 200
+            Quickeebooks::Online::Model::CompanyMetaData.from_xml(response.body)
+          else
+            nil
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/quickeebooks/online/service/customer.rb

@@ -9,7 +9,7 @@ module Quickeebooks
         def create(customer)
           raise InvalidModelException unless customer.valid?
           xml = customer.to_xml_ns
-          response = do_http_post(url_for_resource("customer"), valid_xml_document(xml))
+          response = do_http_post(url_for_resource(Quickeebooks::Online::Model::Customer.resource_for_singular), valid_xml_document(xml))
           if response.code.to_i == 200
             Quickeebooks::Online::Model::Customer.from_xml(response.body)
           else
@@ -18,7 +18,7 @@ module Quickeebooks
         end
 
         def fetch_by_id(id)
-          url = "#{url_for_resource("customer")}/#{id}"
+          url = "#{url_for_resource(Quickeebooks::Online::Model::Customer.resource_for_singular)}/#{id}"
           response = do_http_get(url)
           if response && response.code.to_i == 200
             Quickeebooks::Online::Model::Customer.from_xml(response.body)
@@ -29,7 +29,7 @@ module Quickeebooks
 
         def update(customer)
           raise InvalidModelException.new("Missing required parameters for update") unless customer.valid_for_update?
-          url = "#{url_for_resource("customer")}/#{customer.id}"
+          url = "#{url_for_resource(Quickeebooks::Online::Model::Customer.resource_for_singular)}/#{customer.id.value}"
           xml = customer.to_xml_ns
           response = do_http_post(url, valid_xml_document(xml))
           if response.code.to_i == 200
@@ -42,13 +42,13 @@ module Quickeebooks
         def delete(customer)
           raise InvalidModelException.new("Missing required parameters for delete") unless customer.valid_for_deletion?
           xml = valid_xml_document(customer.to_xml_ns(:fields => ['Id', 'SyncToken']))
-          url = "#{url_for_resource("customer")}/#{customer.id}"
+          url = "#{url_for_resource(Quickeebooks::Online::Model::Customer.resource_for_singular)}/#{customer.id.value}"
           response = do_http_post(url, xml, {:methodx => "delete"})
           response.code.to_i == 200
         end
 
         def list(filters = [], page = 1, per_page = 20, sort = nil, options = {})
-          fetch_collection("customers", "Customer", Quickeebooks::Online::Model::Customer, filters, page, per_page, sort, options)
+          fetch_collection(Quickeebooks::Online::Model::Customer, filters, page, per_page, sort, options)
         end
 
       end

data/lib/quickeebooks/online/service/invoice.rb

@@ -9,7 +9,36 @@ module Quickeebooks
     module Service
       class Invoice < ServiceBase
 
+        def create(invoice)
+          raise InvalidModelException unless invoice.valid?
+          xml = invoice.to_xml_ns
+          response = do_http_post(url_for_resource(Quickeebooks::Online::Model::Invoice.resource_for_singular), valid_xml_document(xml))
+          if response.code.to_i == 200
+            Quickeebooks::Online::Model::Invoice.from_xml(response.body)
+          else
+            nil
+          end
+        end
+
+        # Fetch an invoice by its ID
+        # Returns: +Invoice+ object
+        def fetch_by_id(invoice_id)
+          response = do_http_get("#{url_for_resource(Quickeebooks::Online::Model::Invoice::REST_RESOURCE)}/#{invoice_id}")
+          Quickeebooks::Online::Model::Invoice.from_xml(response.body)
+        end
 
+        def update(invoice)
+          raise InvalidModelException.new("Missing required parameters for update") unless invoice.valid_for_update?
+          url = "#{url_for_resource(Quickeebooks::Online::Model::Invoice.resource_for_singular)}/#{invoice.id}"
+          xml = invoice.to_xml_ns
+          response = do_http_post(url, valid_xml_document(xml))
+          if response.code.to_i == 200
+            Quickeebooks::Online::Model::Invoice.from_xml(response.body)
+          else
+            nil
+          end
+        end
+        
         # Fetch a +Collection+ of +Invoice+ objects
         # Arguments:
         # filters: Array of +Filter+ objects to apply
@@ -18,30 +47,30 @@ module Quickeebooks
         # sort: +Sort+ object
         # options: +Hash+ extra arguments
         def list(filters = [], page = 1, per_page = 20, sort = nil, options = {})
-          fetch_collection("invoices", "Invoice", Quickeebooks::Online::Model::Invoice, filters, page, per_page, sort, options)
+          fetch_collection(Quickeebooks::Online::Model::Invoice, filters, page, per_page, sort, options)
         end
 
         # Returns the absolute path to the PDF on disk
         # Its left to the caller to unlink the file at some later date
         # Returns: +String+ : absolute path to file on disk or nil if couldnt fetch PDF
-        def invoice_as_pdf(invoice_id, destination_parent_directory)
+        def invoice_as_pdf(invoice_id, destination_file_name)
           response = do_http_get("#{url_for_resource("invoice-document")}/#{invoice_id}", {}, {'Content-Type' => 'application/pdf'})
           if response && response.code.to_i == 200
-            file_name = File.join(destination_parent_directory, "invoice-document-#{invoice_id}-#{Time.now.strftime('%Y-%m-%d_%H-%M')}.pdf")
-            File.open(file_name, "wb") do |file|
+            File.open(destination_file_name, "wb") do |file|
               file.write(response.body)
             end
-            file_name
+            destination_file_name
           else
             nil
           end
         end
 
-        # Fetch an invoice by its ID
-        # Returns: +Invoice+ object
-        def fetch_by_id(invoice_id)
-          response = do_http_get("#{url_for_resource("invoice")}/#{invoice_id}")
-          Quickeebooks::Online::Model::Invoice.from_xml(response.body)
+        def delete(invoice)
+          raise InvalidModelException.new("Missing required parameters for delete") unless invoice.valid_for_deletion?
+          xml = valid_xml_document(invoice.to_xml_ns(:fields => ['Id', 'SyncToken']))
+          url = "#{url_for_resource(Quickeebooks::Online::Model::Invoice::REST_RESOURCE)}/#{invoice.id}"
+          response = do_http_post(url, xml, {:methodx => "delete"})
+          response.code.to_i == 200
         end
 
       end

data/lib/quickeebooks/online/service/item.rb

@@ -7,13 +7,13 @@ module Quickeebooks
       class Item < ServiceBase
 
         def list(filters = [], page = 1, per_page = 20, sort = nil, options = {})
-          fetch_collection("items", "Item", Quickeebooks::Online::Model::Item, filters, page, per_page, sort, options)
+          fetch_collection(Quickeebooks::Online::Model::Item, filters, page, per_page, sort, options)
         end
 
         def create(item)
           raise InvalidModelException unless item.valid?
           xml = item.to_xml_ns
-          response = do_http_post(url_for_resource("item"), valid_xml_document(xml))
+          response = do_http_post(url_for_resource(Quickeebooks::Online::Model::Item.resource_for_singular), valid_xml_document(xml))
           if response && response.code.to_i == 200
             Quickeebooks::Online::Model::Item.from_xml(response.body)
           else
@@ -24,7 +24,7 @@ module Quickeebooks
         def update(item)
           raise InvalidModelException unless item.valid?
           xml = item.to_xml_ns
-          url = "#{url_for_resource("item")}/#{item.id}"
+          url = "#{url_for_resource(Quickeebooks::Online::Model::Item.resource_for_singular)}/#{item.id}"
           response = do_http_post(url, valid_xml_document(xml))
           if response && response.code.to_i == 200
             Quickeebooks::Online::Model::Item.from_xml(response.body)
@@ -34,14 +34,14 @@ module Quickeebooks
         end
 
         def fetch_by_id(id)
-          response = do_http_get("#{url_for_resource("item")}/#{id}")
+          response = do_http_get("#{url_for_resource(Quickeebooks::Online::Model::Item.resource_for_singular)}/#{id}")
           Quickeebooks::Online::Model::Item.from_xml(response.body)
         end
 
         def delete(item)
           raise InvalidModelException.new("Missing required parameters for delete") unless item.valid_for_deletion?
           xml = valid_xml_document(item.to_xml_ns(:fields => ['Id', 'SyncToken']))
-          url = "#{url_for_resource("item")}/#{item.id}"
+          url = "#{url_for_resource(Quickeebooks::Online::Model::Item.resource_for_singular)}/#{item.id}"
           response = do_http_post(url, xml, {:methodx => "delete"})
           response.code.to_i == 200
         end

data/lib/quickeebooks/online/service/payment.rb

@@ -0,0 +1,63 @@
+require 'quickeebooks/online/service/service_base'
+require 'quickeebooks/online/model/payment'
+require 'quickeebooks/online/model/payment_header'
+require 'quickeebooks/online/model/payment_line_item'
+require 'quickeebooks/online/model/payment_detail'
+require 'quickeebooks/online/model/credit_card'
+require 'quickeebooks/online/model/credit_charge_info'
+require 'quickeebooks/online/model/credit_charge_response'
+require 'nokogiri'
+
+module Quickeebooks
+  module Online
+    module Service
+      class Payment < ServiceBase
+
+        def create(payment)
+          raise InvalidModelException unless payment.valid?
+          xml = payment.to_xml_ns
+          response = do_http_post(url_for_resource(Quickeebooks::Online::Model::Payment.resource_for_singular), valid_xml_document(xml))
+          if response.code.to_i == 200
+            Quickeebooks::Online::Model::Payment.from_xml(response.body)
+          else
+            nil
+          end
+        end
+
+        def fetch_by_id(id)
+          url = "#{url_for_resource(Quickeebooks::Online::Model::Payment.resource_for_singular)}/#{id}"
+          response = do_http_get(url)
+          if response && response.code.to_i == 200
+            Quickeebooks::Online::Model::Payment.from_xml(response.body)
+          else
+            nil
+          end
+        end
+
+        def update(payment)
+          raise InvalidModelException.new("Missing required parameters for update") unless payment.valid_for_update?
+          url = "#{url_for_resource(Quickeebooks::Online::Model::Payment.resource_for_singular)}/#{payment.id}"
+          xml = payment.to_xml_ns
+          response = do_http_post(url, valid_xml_document(xml))
+          if response.code.to_i == 200
+            Quickeebooks::Online::Model::Payment.from_xml(response.body)
+          else
+            nil
+          end
+        end
+
+        def list(filters = [], page = 1, per_page = 20, sort = nil, options = {})
+          fetch_collection(Quickeebooks::Online::Model::Payment, filters, page, per_page, sort, options)
+        end
+        
+        def delete(payment)
+          raise InvalidModelException.new("Missing required parameters for delete") unless payment.valid_for_deletion?
+          xml = valid_xml_document(payment.to_xml_ns(:fields => ['Id', 'SyncToken']))
+          url = "#{url_for_resource(Quickeebooks::Online::Model::Payment.resource_for_singular)}/#{payment.id}"
+          response = do_http_post(url, xml, {:methodx => "delete"})
+          response.code.to_i == 200
+        end
+      end
+    end
+  end
+end