quickeebooks 0.1.8 → 0.1.9

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

@@ -27,6 +27,20 @@ module Quickeebooks
           ensure_line_items_initialization
         end
 
+        def valid_for_create?
+          valid?
+          if header.nil?
+            errors.add(:header, "Missing Header field for Create")
+          # else
+          #   # ensure header is valid
+          #   unless header.valid?
+          #     #errors.concat(header.errors)
+          #     #errors[:base].each {|e| header.errors[:base] << e }
+          #   end
+          end
+          errors.empty?
+        end
+
         private
 
         def after_parse

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

@@ -5,19 +5,45 @@ module Quickeebooks
   module Windows
     module Model
       class PaymentHeader < Quickeebooks::Windows::Model::IntuitType
+        include ActiveModel::Validations
+
         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::Windows::Model::Id
-        xml_accessor :customer_name,         :from => 'CustomerName'
-        xml_accessor :deposit_to_account_id, :from => 'DepositToAccountId', :as => Quickeebooks::Windows::Model::Id
-        xml_accessor :payment_method_id,     :from => 'PaymentMethodId',    :as => Quickeebooks::Windows::Model::Id
-        xml_accessor :payment_method_name,   :from => 'PaymentMethodName'
-        xml_accessor :detail,                :from => 'Detail',             :as => Quickeebooks::Windows::Model::PaymentDetail
-        xml_accessor :total_amount,          :from => 'TotalAmt',           :as => Float
-        xml_accessor :process_payment,       :from => 'ProcessPayment'
+        xml_accessor :doc_number,               :from => 'DocNumber'
+        xml_accessor :txn_date,                 :from => 'TxnDate',           :as => Time
+        xml_accessor :currency,                 :from => 'Currency'
+        xml_accessor :note,                     :from => 'Note'
+        xml_accessor :status,                   :from => 'Status'
+        xml_accessor :customer_id,              :from => 'CustomerId',        :as => Quickeebooks::Windows::Model::Id
+        xml_accessor :customer_name,            :from => 'CustomerName'
+        xml_accessor :job_id,                   :from => 'JobId',             :as => Quickeebooks::Windows::Model::Id
+        xml_accessor :job_name,                 :from => 'JobName'
+        xml_accessor :remit_to_id,              :from => 'RemitToId',         :as => Quickeebooks::Windows::Model::Id
+        xml_accessor :remit_to_name,            :from => 'RemitToName'
+        xml_accessor :ar_account_id,            :from => 'ARAccountId',       :as => Quickeebooks::Windows::Model::Id
+        xml_accessor :ar_account_name,          :from => 'ARAccountName'
+        xml_accessor :deposit_to_account_id,    :from => 'DepositToAccountId', :as => Quickeebooks::Windows::Model::Id
+        xml_accessor :deposit_to_account_name,  :from => 'DepositToAccountName'
+        xml_accessor :payment_method_id,        :from => 'PaymentMethodId',    :as => Quickeebooks::Windows::Model::Id
+        xml_accessor :payment_method_name,      :from => 'PaymentMethodName'
+        xml_accessor :detail,                   :from => 'Detail',             :as => Quickeebooks::Windows::Model::PaymentDetail
+        xml_accessor :total_amount,             :from => 'TotalAmt',           :as => Float
+        xml_accessor :process_payment,          :from => 'ProcessPayment'
+        
+        validate :customer_is_valid
+        
+        private
+        
+        def customer_is_valid
+          if customer_id.nil?
+            errors.add(:customer_id, "Missing customer_id")
+          else
+            # ensure its we have a non-blank Customer ID value
+            if customer_id.to_s.length == 0
+              errors.add(:customer_id, "customer_id is supplied but its value is empty")
+            end
+          end
+        end
+        
       end
     end
   end

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

@@ -6,9 +6,10 @@ module Quickeebooks
       class PaymentLineItem < Quickeebooks::Windows::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 :amount,     :from => 'Amount',    :as => Float
         xml_accessor :txn_id,     :from => 'TxnId', :as => Quickeebooks::Windows::Model::Id
+        xml_accessor :txn_num,    :from => 'TxnNum'
       end
     end
   end

data/lib/quickeebooks/windows/model/payment_method.rb

@@ -0,0 +1,28 @@
+module Quickeebooks
+  module Windows
+    module Model
+      class PaymentMethod  < Quickeebooks::Windows::Model::IntuitType
+        include ActiveModel::Validations
+
+        XML_COLLECTION_NODE = 'PaymentMethods'
+        XML_NODE = 'PaymentMethod'
+        
+        # https://services.intuit.com/sb/paymentmethod/v2/<realmID>
+        REST_RESOURCE = "paymentmethod"
+
+        xml_name 'PaymentMethod'
+        xml_convention :camelcase
+        xml_accessor :id,             :from => 'Id',            :as => Quickeebooks::Windows::Model::Id
+        xml_accessor :sync_token,     :from => 'SyncToken',     :as => Integer
+        xml_accessor :meta_data,      :from => 'MetaData',      :as => Quickeebooks::Windows::Model::MetaData
+        xml_accessor :external_key,   :from => 'ExternalKey'
+        xml_accessor :custom_fields,  :from => 'CustomField',   :as => [Quickeebooks::Windows::Model::CustomField]
+        xml_accessor :name,           :from => 'Name'
+        xml_accessor :active,         :from => 'Active'
+        xml_accessor :type,           :from => 'Type'
+        
+        validates_length_of :name, :minimum => 1
+      end
+    end
+  end
+end

data/lib/quickeebooks/windows/model/sync_status_param.rb

@@ -0,0 +1,28 @@
+require 'quickeebooks/windows/model/id_set'
+
+module Quickeebooks
+  module Windows
+    module Model
+      class SyncStatusParam < Quickeebooks::Windows::Model::IntuitType
+        xml_convention :camelcase
+        xml_accessor :id_set, :from => 'IdSet', :as => Quickeebooks::Windows::Model::IdSet
+        xml_accessor :sync_token, :from => 'SyncToken'
+        xml_accessor :object_type, :from => 'ObjectType'
+        xml_accessor :party_id, :from => 'PartyId'
+        
+        def initialize(value = nil)
+          self.id_set = Quickeebooks::Windows::Model::IdSet.new(value)
+        end
+        
+        def to_i
+          self.id_set ? self.id_set.to_i : "__uninitialized__"
+        end
+        
+        def to_s
+          self.id_set ? self.id_set.to_s : "__uninitialized__"
+        end
+        
+      end
+    end
+  end
+end

data/lib/quickeebooks/windows/model/sync_status_request.rb

@@ -0,0 +1,31 @@
+require 'quickeebooks/windows/model/id'
+require 'quickeebooks/windows/model/id_set'
+require 'quickeebooks/windows/model/sync_status_param'
+
+module Quickeebooks
+  module Windows
+    module Model
+      class SyncStatusRequest < Quickeebooks::Windows::Model::IntuitType
+
+        DEFAULT_OFFERING_ID = 'ipp'
+        
+        # https://services.intuit.com/sb/status/v2/<realmID>
+        REST_RESOURCE = "status"
+        
+        xml_convention :camelcase
+        xml_accessor :offering_id
+        xml_accessor :sync_status_param, :from => 'SyncStatusParam', :as => Quickeebooks::Windows::Model::SyncStatusParam
+        
+        def initialize(id = nil, type = nil)
+          self.offering_id = DEFAULT_OFFERING_ID
+          
+          if id && type
+            self.sync_status_param = Quickeebooks::Windows::Model::SyncStatusParam.new(id)
+            self.sync_status_param.object_type = type
+          end
+        end
+        
+      end
+    end
+  end
+end

data/lib/quickeebooks/windows/model/sync_status_response.rb

@@ -0,0 +1,156 @@
+module Quickeebooks
+  module Windows
+    module Model
+      class SyncStatusResponse < Quickeebooks::Windows::Model::IntuitType
+
+        XML_COLLECTION_NODE = 'SyncStatusResponses'
+        XML_NODE = 'SyncStatusResponse'
+        # https://services.intuit.com/sb/status/v2/<realmID>
+        REST_RESOURCE = "status"
+                
+        STATE_CODES = {
+          1 => {
+            :desc => 'Synchronized',
+            :verbose => 'Synchronized (successful). Object created in QuickBooks. Equivalent to StateCode 8 (for object created in Data Services).'
+          },
+          2 => {
+            :desc => 'Source record created',
+            :verbose => 'Not synchronized. Object created in Quickbooks.'
+          },
+          3 => {
+            :desc => 'Source record modified',
+            :verbose => 'Not synchronized. Object modified in Quickbooks.'
+          },
+          4 => {
+            :desc => 'Next Gen record created',
+            :verbose => 'Not synchronized. Object created in Data Services. The same object subsequently modified on the cloud, without being sync\'d, will retain a StateCode 4 until it has been sync\'d with QuickBooks and then modified.'
+          },
+          5 => {
+            :desc => 'Next Gen record modified',
+            :verbose => 'Not synchronized. Object modified in Data Services that has been sync\'d at least once with QuickBooks.'
+          },
+          6 => {
+            :desc => 'Next Gen to Source, no ack',
+            :verbose => 'Not synchronzied. The synchronization is currently in progress; Sync Manager has not completed processing or acknowledged completion.'
+          },
+          7 => {
+            :desc => 'Record has conflict',
+            :verbose => 'Not synchronized. To resolve this conflict, change the object in Data Services.'
+          },
+          8 => {
+            :desc => 'Record netted',
+            :verbose => 'Synchronized. Object created in Data Services. Sync Manager has acknowledged synchronizing the object and mapped its NG ID to a QB ID in QuickBooks. Equivalent to StateCode 1 (for object created in QuickBooks).'
+          },
+          9 => {
+            :desc => 'Record has conflict, unrecoverable',
+            :verbose => 'Not synchronized. The synchronization was rejected by Quickbooks because of a bad record or unsupported operation.'
+          }
+        }
+        
+        MESSAGE_CODES = {
+          10 => {
+            :desc => 'ADD success',
+            :verbose => 'Object to be added was successfully written to Data Services, awaiting synch with QuickBooks.'
+          },
+          20 => {
+            :desc => 'MOD success',
+            :verbose => 'Object to be modified was successfully modified in Data Services, awaiting synch with QuickBooks.'
+          },
+          30 => {
+            :desc => 'QBXML sent to desktop',
+            :verbose => 'Requests have been sent down from Data Services to the QuickBooks desktop company file for an attempted synch.'
+          },
+          40 => {
+            :desc => 'WRTB success',
+            :verbose => 'The requests sent from Data Services to the QuickBooks company file were successfully synched into the company file.'
+          },
+          50 => {
+            :desc => 'WRTB error',
+            :verbose => 'The requests sent from Data Services to the QuickBooks company file failed to synch and are not in the company file.'
+          },
+          60 => {
+            :desc => 'ADD MOD error',
+            :verbose => 'The Add or Mod of an object in Data Services failed. The object was not added to Data Services or modified in Data Services.'
+          },
+          80 => {
+            :desc => 'Auto_Revert',
+            :verbose => 'This error is returned whenever an object, which fails to synchronize due to write back errors, is reverted to a state prior to the error.'
+          },
+          90 => {
+            :desc => 'DEL success',
+            :verbose => nil
+          },
+          100 => {
+            :desc => 'Generic QB SDK communication failure',
+            :verbose => nil
+          },
+          110 => {
+            :desc => 'Upload ADD success',
+            :verbose => nil
+          },
+          120 => {
+            :desc => 'Upload MOD success',
+            :verbose => nil
+          },
+          130 => {
+            :desc => 'Upload error',
+            :verbose => nil
+          },
+          200 => {
+            :desc => 'Missing ExtAcctId with state = 1, forcing to state = 7',
+            :verbose => 'Objects now have StateCode 7.'
+          },
+          210 => {
+            :desc => 'Orphaned state = 8, forcing to state = 7',
+            :verbose => 'Objects are orphaned when they existed on the cloud, synchronization with QuickBooks did not complete, but then the user restored an older company file from backup on the desktop, then sync\'d; the objects on the cloud have lost their corresponding QuickBooks identity and cannot be resolved, so they have been forced back to StateCode 7.'
+          },
+          220 => {
+            :desc => 'Stuck while in state = 6, forcing to state = 7',
+            :verbose => 'Objects now have StateCode 7.'
+          },
+          230 => {
+            :desc => 'Stuck while in state = 6, forcing to prior state',
+            :verbose => 'Objects have been rolled back to previous state. No synchronization occurred.'
+          },
+          240 => {
+            :desc => 'Internal WRTB to ESB API ack error - Sync Manager failed validation',
+            :verbose => 'Objects now have StateCode 7.'
+          },
+          250 => {
+            :desc => 'State Rollback all prior objects',
+            :verbose => 'Objects have been rolled back to previous state. No synchronization occurred.'
+          }
+        }
+        
+        xml_convention :camelcase
+        xml_accessor :offering_id, :as => Quickeebooks::Windows::Model::Id
+        xml_accessor :ng_id_set, :as => Quickeebooks::Windows::Model::NgIdSet
+        xml_accessor :request_id, :from => 'RequestId'
+        xml_accessor :batch_id, :from => 'BatchId'
+
+        xml_accessor :state_code, :from => 'StateCode'
+        xml_accessor :state_desc, :from => 'StateDesc'
+        xml_accessor :message_code, :from => 'MessageCode'
+        xml_accessor :message_desc, :from => 'MessageDesc'
+        xml_accessor :response_log_tms, :from => 'ResponseLogTMS', :as => Time
+        
+        def verbose_state_description
+          if STATE_CODES[state_code.to_i]
+            STATE_CODES[state_code.to_i][:verbose]
+          else
+            nil
+          end
+        end
+
+        def verbose_message_description
+          if MESSAGE_CODES[message_code.to_i]
+            MESSAGE_CODES[message_code.to_i][:verbose]
+          else
+            nil
+          end
+        end
+        
+      end
+    end
+  end
+end

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

@@ -20,6 +20,20 @@ module Quickeebooks
         def list(filters = [], page = 1, per_page = 20, sort = nil, options = {})
           fetch_collection(Quickeebooks::Windows::Model::Payment, nil, filters, page, per_page, sort, options)
         end
+        
+        def create(payment)
+          raise InvalidModelException unless payment.valid_for_create?
+
+          # XML is a wrapped 'object' where the type is specified as an attribute
+          #    <Object xsi:type="Invoice">
+          xml_node = payment.to_xml(:name => 'Object')
+          xml_node.set_attribute('xsi:type', 'Payment')
+          xml = Quickeebooks::Shared::Service::OperationNode.new.add do |content|
+            content << "<ExternalRealmId>#{self.realm_id}</ExternalRealmId>#{xml_node}"
+          end
+          perform_write(Quickeebooks::Windows::Model::Payment, xml)
+        end
+        
       end
     end
   end

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

@@ -0,0 +1,24 @@
+# require 'quickeebooks/windows/service/service_base'
+# require 'quickeebooks/windows/model/payment'
+# require 'quickeebooks/windows/model/payment_method'
+# require 'quickeebooks/windows/model/payment_line_item'
+# require 'quickeebooks/windows/model/payment_detail'
+# require 'quickeebooks/windows/model/credit_card'
+# require 'quickeebooks/windows/model/credit_charge_info'
+# require 'quickeebooks/windows/model/credit_charge_response'
+# require 'nokogiri'
+
+module Quickeebooks
+  module Windows
+    module Service
+      class PaymentMethod < ServiceBase
+
+        def list(filters = [], page = 1, per_page = 20, sort = nil, options = {})
+          fetch_collection(Quickeebooks::Windows::Model::PaymentMethod, nil, filters, page, per_page, sort, options)
+        end
+        
+        
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require 'quickeebooks/windows/service/service_base'
+require 'quickeebooks/windows/model/sync_status_request'
+
+module Quickeebooks
+  module Windows
+    module Service
+      class SyncStatus < Quickeebooks::Windows::Service::ServiceBase
+
+        def retrieve(sync_status_request, errored_objects_only = false)
+          unless sync_status_request.is_a?(Quickeebooks::Windows::Model::SyncStatusRequest)
+            raise ArgumentError.new("Expecting an +SyncStatusRequest+ instance as an argument") 
+          end
+          
+          xml_node = sync_status_request.to_xml
+          
+          if errored_objects_only
+            xml_node.set_attribute('ErroredObjectsOnly', 'true')
+          end
+
+          xml_node.set_attribute('xmlns', 'http://www.intuit.com/sb/cdm/v2')
+          xml_node.set_attribute('xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance')
+          xml_node.set_attribute('xsi:schemaLocation', 'http://www.intuit.com/sb/cdm/v2 RestDataFilter.xsd ')
+          
+          xml = xml_node.to_s
+
+          model = Quickeebooks::Windows::Model::SyncStatusResponse
+          response = do_http_post(url_for_resource(model::REST_RESOURCE), xml, {}, {'Content-Type' => 'text/xml'})
+          parse_collection(response, model)
+        end
+
+      end
+    end
+  end
+end

data/quickeebooks.gemspec

@@ -23,6 +23,8 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rake'
   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 'rspec',  '2.13.0'
   gem.add_development_dependency 'fakeweb'
+  gem.add_development_dependency 'guard', '1.8.0'
+  gem.add_development_dependency 'guard-rspec', '3.0.0'
 end

data/spec/quickeebooks/online/bill_payment_spec.rb

@@ -0,0 +1,18 @@
+describe "Quickeebooks::Online::Model::BillPayment" do
+
+  describe "parse bill payment from XML" do
+    it "should properly parse bill payment from XML" do
+      xml = onlineFixture("bill_payment.xml")
+      bill_payment = Quickeebooks::Online::Model::BillPayment.from_xml(xml)
+      bill_payment.id.value.should == '13'
+      bill_payment.sync_token.should == 0
+      bill_payment.header.doc_number.should == '15'
+      bill_payment.header.entity_id.value.should == '1'
+      bill_payment.header.total_amount.should == 5000.0
+      bill_payment.line_items.size.should == 1
+      bill_payment.line_items[0].amount.should == 5000.0
+      bill_payment.line_items[0].txn_id.value.should == '12'
+    end
+  end
+
+end