quickeebooks 0.0.3 → 0.0.4

data/Gemfile.lock

@@ -1,44 +1,44 @@
 PATH
   remote: .
   specs:
-    quickeebooks (0.0.1)
+    quickeebooks (0.0.4)
       activemodel
       nokogiri
       oauth
       roxml
+      uuidtools
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.2.1)
-      activesupport (= 3.2.1)
+    activemodel (3.2.6)
+      activesupport (= 3.2.6)
       builder (~> 3.0.0)
-    activesupport (3.2.1)
+    activesupport (3.2.6)
       i18n (~> 0.6)
       multi_json (~> 1.0)
     builder (3.0.0)
     diff-lcs (1.1.3)
     fakeweb (1.3.0)
     i18n (0.6.0)
-    multi_json (1.1.0)
-    nokogiri (1.5.0)
-    oauth (0.4.5)
+    multi_json (1.3.6)
+    nokogiri (1.5.5)
+    oauth (0.4.6)
     rake (0.9.2.2)
     rcov (0.9.11)
     roxml (3.3.1)
       activesupport (>= 2.3.0)
       nokogiri (>= 1.3.3)
     rr (1.0.4)
-    rspec (2.0.1)
-      rspec-core (~> 2.0.1)
-      rspec-expectations (~> 2.0.1)
-      rspec-mocks (~> 2.0.1)
-    rspec-core (2.0.1)
-    rspec-expectations (2.0.1)
-      diff-lcs (>= 1.1.2)
-    rspec-mocks (2.0.1)
-      rspec-core (~> 2.0.1)
-      rspec-expectations (~> 2.0.1)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.0)
+    rspec-expectations (2.11.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+    uuidtools (2.1.2)
 
 PLATFORMS
   ruby
@@ -49,4 +49,4 @@ DEPENDENCIES
   rake
   rcov (~> 0.9.8)
   rr (~> 1.0.2)
-  rspec (~> 2.0.0)
+  rspec (= 2.11.0)

data/README.md

@@ -58,6 +58,7 @@ customer_service.list
 # Instantiate a Windows API
 customer_service = Quickeebooks::Windows::Service::Customer.new(oauth_client, realm_id)
 customer_service.list 
+```
 
 All of the documentation below is geared towards the Online flavor but unless noted one should be able to replace it with Windows.
 
@@ -284,10 +285,16 @@ Current Services:
 The `Quickeebooks::Online::Service::Invoice` has the ability to retrieve an invoice as a PDF document:
 
 ```ruby
-invoice_as_pdf(invoice_id)
+invoice_as_pdf(invoice_id, destination_file_name)
+```
+
+Usage: Download invoice #89 and store it at `/tmp/invoice.pdf`:
+
+```ruby
+invoice_as_pdf(89, "/tmp/invoice.pdf")
 ```
 
-The `invoice_as_pdf` method returns a string representing the path to the PDF on the local disk. The method uses `ENV['TMPDIR']` to write the file to a temporary storage location. _Note:_ it is up to you the caller to remove or clean up the file when you are done.
+_Note:_ it is up to you the caller to remove or clean up the file when you are done.
 
 ## Author
 

data/Rakefile

@@ -12,6 +12,6 @@ require "quickeebooks"
 task :default => :spec
 
 desc "Run all specs"
-Rspec::Core::RakeTask.new(:spec) do |t|
+RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = 'spec/**/*_spec.rb'
 end

data/lib/quickeebooks.rb

@@ -32,7 +32,7 @@ module ROXML
       params[:fields] ||= []
       params.reverse_merge!(:name => self.class.tag_name, :namespace => self.class.roxml_namespace)
       params[:namespace] = nil if ['*', 'xmlns'].include?(params[:namespace])
-      XML.new_node([params[:namespace], params[:name]].compact.join(':')).tap do |root|
+      node = XML.new_node([params[:namespace], params[:name]].compact.join(':')).tap do |root|
         refs = (self.roxml_references.present? \
           ? self.roxml_references \
           : self.class.roxml_attrs.map {|attr| attr.to_ref(self) })
@@ -55,6 +55,7 @@ end
 
 # Models
 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/invoice'
@@ -65,25 +66,60 @@ require 'quickeebooks/online/model/unit_price'
 require 'quickeebooks/online/model/meta_data'
 require 'quickeebooks/online/model/price'
 require 'quickeebooks/online/model/account_reference'
+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'
 
 # Services
 require 'quickeebooks/online/service/filter'
 require 'quickeebooks/online/service/pagination'
 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/invoice'
 require 'quickeebooks/online/service/item'
 require 'quickeebooks/online/service/entitlement'
+require 'quickeebooks/online/service/payment'
 
 #== Windows
+
+# Models
 require 'quickeebooks/windows/model/intuit_type'
+require 'quickeebooks/windows/model/id'
 require 'quickeebooks/windows/model/custom_field'
 require 'quickeebooks/windows/model/price'
 require 'quickeebooks/windows/model/customer'
 require 'quickeebooks/windows/model/account'
 require 'quickeebooks/windows/model/item'
+require 'quickeebooks/windows/model/invoice'
+require 'quickeebooks/windows/model/invoice_header'
+require 'quickeebooks/windows/model/invoice_line_item'
+require 'quickeebooks/windows/model/address'
+require 'quickeebooks/windows/model/rest_response'
+require 'quickeebooks/windows/model/success'
+require 'quickeebooks/windows/model/error'
+require 'quickeebooks/windows/model/object_ref'
+require 'quickeebooks/windows/model/sales_rep'
+require 'quickeebooks/windows/model/vendor'
+require 'quickeebooks/windows/model/vendor_id'
+require 'quickeebooks/windows/model/external_key'
+require 'quickeebooks/windows/model/ship_method'
+require 'quickeebooks/windows/model/sales_tax'
+require 'quickeebooks/windows/model/customer_msg'
+
+
+# Services
 require 'quickeebooks/windows/service/service_base'
 require 'quickeebooks/windows/service/account'
 require 'quickeebooks/windows/service/customer'
 require 'quickeebooks/windows/service/item'
+require 'quickeebooks/windows/service/invoice'
+require 'quickeebooks/windows/service/sales_rep'
+require 'quickeebooks/windows/service/ship_method'
+require 'quickeebooks/windows/service/sales_tax'
+require 'quickeebooks/windows/service/customer_msg'

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

@@ -1,12 +1,17 @@
 require "quickeebooks"
 require "quickeebooks/online/model/meta_data"
 require "quickeebooks/online/model/account_detail_type"
+require "quickeebooks/online/model/id"
 
 module Quickeebooks
   module Online
     module Model
       class Account < Quickeebooks::Online::Model::IntuitType
         include ActiveModel::Validations
+        
+        REST_RESOURCE = "account"
+        XML_NODE = "Account"
+        
         xml_convention :camelcase
         xml_accessor :id, :from => 'Id'
         xml_accessor :sync_token, :from => 'SyncToken', :as => Integer
@@ -15,7 +20,7 @@ module Quickeebooks
         xml_accessor :desc, :from => 'Desc'
         xml_accessor :sub_type, :from => 'Subtype'
         xml_accessor :acct_num, :from => 'AcctNum'
-        xml_accessor :account_parent_id, :from => 'AccountParentId'
+        xml_accessor :account_parent_id, :from => 'AccountParentId', :as => Quickeebooks::Online::Model::Id
         xml_accessor :current_balance, :from => 'CurrentBalance', :as => Float
         xml_accessor :opening_balance_date, :from => 'OpeningBalanceDate', :as => Date
 
@@ -25,6 +30,7 @@ module Quickeebooks
         def to_xml_ns(options = {})
           to_xml_inject_ns('Account', options)
         end
+        
 
         def valid_for_update?
           if sync_token.nil?
@@ -39,6 +45,11 @@ module Quickeebooks
           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
 
       end
     end

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

@@ -0,0 +1,30 @@
+# see https://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0050_Data_Services/0400_QuickBooks_Online/CompanyMetaData
+require "quickeebooks"
+require "quickeebooks/online/model/address"
+require "quickeebooks/online/model/phone"
+require "quickeebooks/online/model/email"
+
+module Quickeebooks
+  module Online
+    module Model
+      class CompanyMetaData < Quickeebooks::Online::Model::IntuitType
+        include ActiveModel::Validations
+        
+        REST_RESOURCE = "companymetadata"
+
+        xml_convention :camelcase
+        xml_accessor :external_realm_id, :from => 'ExternalRealmId'
+        xml_accessor :registered_company_name, :from => 'QBNRegisteredCompanyName'
+        xml_accessor :industry_type, :from => 'IndustryType'
+        xml_accessor :addresses, :from => 'Address', :as => [Quickeebooks::Online::Model::Address]
+        xml_accessor :legal_address, :from => 'LegalAddress', :as => Quickeebooks::Online::Model::Address
+        xml_accessor :emails, :from => 'Email', :as => [Quickeebooks::Online::Model::Email]
+        xml_accessor :phone, :from => 'Phone', :as => Quickeebooks::Online::Model::Phone
+
+        def to_xml_ns(options = {})
+          to_xml_inject_ns('CompanyMetaData', options)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+require 'quickeebooks/online/model/credit_charge_info'
+require 'quickeebooks/online/model/credit_charge_response'
+
+module Quickeebooks
+  module Online
+    module Model
+      class CreditCard  < Quickeebooks::Online::Model::IntuitType
+        xml_name 'CreditCard'
+        xml_accessor :credit_charge_info,     :from => 'CreditChargeInfo',     :as => Quickeebooks::Online::Model::CreditChargeInfo
+        xml_accessor :credit_charge_response, :from => 'CreditChargeResponse', :as => Quickeebooks::Online::Model::CreditChargeResponse
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Quickeebooks
+  module Online
+    module Model
+      class CreditChargeInfo  < Quickeebooks::Online::Model::IntuitType
+        xml_name 'CreditChargeInfo'
+        xml_accessor :number,                 :from => 'Number'
+        xml_accessor :type,                   :from => 'Type'
+        xml_accessor :name_on_acct,           :from => 'NameOnAcct'
+        xml_accessor :cc_expiration_month,    :from => 'CcExpireMn', :as => Integer
+        xml_accessor :cc_expiration_year,     :from => 'CcExpireYr', :as => Integer
+        xml_accessor :billing_address_street, :from => 'BillAddrStreet'
+        xml_accessor :zip_code,               :from => 'ZipCode'
+        xml_accessor :cvv,                    :from => 'Ccv'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Quickeebooks
+  module Online
+    module Model
+      class CreditChargeResponse  < Quickeebooks::Online::Model::IntuitType
+        xml_name 'CreditChargeResponse'
+        xml_accessor :cc_transaction_id,      :from => 'CCTransId'
+        xml_accessor :status,                 :from => 'Status'
+        xml_accessor :auth_code,              :from => 'AuthCode'
+        xml_accessor :avs_street,             :from => 'AvsStreet'
+      end
+    end
+  end
+end

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

@@ -1,4 +1,5 @@
 require "quickeebooks"
+require "quickeebooks/online/model/id"
 require "quickeebooks/online/model/meta_data"
 require "quickeebooks/online/model/address"
 require "quickeebooks/online/model/phone"
@@ -13,9 +14,12 @@ module Quickeebooks
     module Model
       class Customer < Quickeebooks::Online::Model::IntuitType
         include ActiveModel::Validations
+        
+        XML_NODE = "Customer"
+        REST_RESOURCE = "customer"
 
         xml_convention :camelcase
-        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 :name, :from => 'Name'
         xml_accessor :meta_data, :from => 'MetaData', :as => Quickeebooks::Online::Model::MetaData
@@ -32,8 +36,8 @@ module Quickeebooks
         xml_accessor :tax_identifier, :from => 'TaxIdentifier'
         xml_accessor :notes, :from => 'Notes', :as => [Quickeebooks::Online::Model::Note]
         xml_accessor :custom_fields, :from => 'CustomField', :as => [Quickeebooks::Online::Model::CustomerCustomField]
-        xml_accessor :sales_term_id, :from => 'SalesTermId'
-        xml_accessor :paymethod_method_id, :from => 'PaymentMethodId'
+        xml_accessor :sales_term_id, :from => 'SalesTermId', :as => Quickeebooks::Online::Model::Id
+        xml_accessor :paymethod_method_id, :from => 'PaymentMethodId', :as => Quickeebooks::Online::Model::Id
         xml_accessor :open_balance, :from => 'OpenBalance', :as => Quickeebooks::Online::Model::OpenBalance
 
         validates_length_of :name, :minimum => 1
@@ -56,9 +60,14 @@ module Quickeebooks
         # To delete an account Intuit requires we provide Id and SyncToken fields
         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
+          id.value.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
+        
       end
     end
   end

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

@@ -0,0 +1,21 @@
+require "quickeebooks"
+
+module Quickeebooks
+  module Online
+    module Model
+      class Id < Quickeebooks::Online::Model::IntuitType
+        
+        
+        DOMAIN = "QBO"
+        
+        xml_convention :camelcase
+        xml_accessor :idDomain, :from => '@idDomain' # Attribute with name 'idDomain'
+        xml_accessor :value, :from => :content
+        
+        def initialize(value = nil)
+          self.value = value
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,24 @@ module Quickeebooks
     module Model
       class IntuitType
         include ROXML
+        
+        # These can be over-ridden in each model object as needed
+        # For the most part a model object has a single resource for all operations
+        # E.g. <baseURL>/resource/invoice/v2/<realmID>
+        # But for the Account object its collection is plural while all other operations are singular
+        # E.g. 
+        # Fetch all accounts: <baseURL>/resource/accounts/v2/<realmID> 
+        #     vs
+        # Create an account, fetch an account, etc: <baseURL>/resource/account/v2/<realmID>
+        def self.resource_for_collection
+          self::REST_RESOURCE
+        end
+
+        def self.resource_for_singular
+          self::REST_RESOURCE
+        end
 
+        
         private
 
         # ROXML doesnt insert the namespaces into generated XML so we need to do it ourselves

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

@@ -1,5 +1,6 @@
 # https://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0050_Data_Services/0400_QuickBooks_Online/Invoice
 
+require 'quickeebooks/online/model/id'
 require 'quickeebooks/online/model/invoice_header'
 require 'quickeebooks/online/model/invoice_line_item'
 require 'quickeebooks/online/model/address'
@@ -11,15 +12,19 @@ module Quickeebooks
     module Model
       class Invoice < Quickeebooks::Online::Model::IntuitType
         include ActiveModel::Validations
+        
+        XML_NODE = "Invoice"
+        REST_RESOURCE = "invoice"
+        
         xml_convention :camelcase
-        xml_accessor :id, :from => 'Id', :as => Integer
+        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::InvoiceHeader
         xml_accessor :bill_address, :from => 'BillAddr', :as => Quickeebooks::Online::Model::Address
         xml_accessor :ship_address, :from => 'ShipAddr', :as => Quickeebooks::Online::Model::Address
         xml_accessor :bill_email, :from => 'BillEmail'
-        xml_accessor :ship_method_id, :from => 'ShipMethodId'
+        xml_accessor :ship_method_id, :from => 'ShipMethodId', :as => Quickeebooks::Online::Model::Id
         xml_accessor :ship_method_name, :from => 'ShipMethodName'
         xml_accessor :balance, :from => 'Balance', :as => Float
         xml_accessor :discount_amount, :from => 'DiscountAmt', :as => Float
@@ -34,6 +39,24 @@ module Quickeebooks
           ensure_line_items_initialization
         end
 
+        def valid_for_update?
+          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 to_xml_ns(options = {})
+          to_xml_inject_ns(XML_NODE, options)
+        end
+        
+        #== Class methods
+        def self.resource_for_collection
+          "#{self::REST_RESOURCE}s"
+        end
+        
         private
 
         def after_parse