quickbooks-ruby-oauth2 0.6.1

data/lib/quickbooks/service/change_service.rb

@@ -0,0 +1,28 @@
+module Quickbooks
+  module Service
+    class ChangeService < BaseService
+
+      def url_for_query(query = nil, start_position = 1, max_results = 20)
+        q = entity
+        q = "#{q}&#{query}" if query.present?
+
+        "#{url_for_base}/cdc?entities=#{q}"
+      end
+
+      def since(timestamp)
+        query("changedSince=#{URI.encode_www_form_component(timestamp.iso8601)}")
+      end
+
+      private
+
+      def entity
+        raise NotImplementedError
+      end
+
+      def model
+        raise NotImplementedError
+      end
+
+    end
+  end
+end

data/lib/quickbooks/service/class.rb

@@ -0,0 +1,23 @@
+module Quickbooks
+  module Service
+    class Class < BaseService
+
+      def update(entity, options = {})
+        raise Quickbooks::InvalidModelException.new('Class sparse update is not supported by Intuit at this time') if options[:sparse] && options[:sparse] == true
+        super(entity, options)
+      end
+
+      def delete(classs)
+        classs.active = false
+        update(classs, :sparse => false)
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::Class
+      end
+
+    end
+  end
+end

data/lib/quickbooks/service/company_info.rb

@@ -0,0 +1,12 @@
+module Quickbooks
+  module Service
+    class CompanyInfo < BaseService
+
+      private
+      
+      def model
+        Quickbooks::Model::CompanyInfo
+      end
+    end
+  end
+end

data/lib/quickbooks/service/credit_memo.rb

@@ -0,0 +1,16 @@
+module Quickbooks
+  module Service
+    class CreditMemo < BaseService
+
+      def delete(credit_memo)
+        delete_by_query_string(credit_memo)
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::CreditMemo
+      end
+    end
+  end
+end

data/lib/quickbooks/service/credit_memo_change.rb

@@ -0,0 +1,16 @@
+module Quickbooks
+  module Service
+    class CreditMemoChange < ChangeService
+
+      private
+
+      def entity
+        "CreditMemo"
+      end
+
+      def model
+        Quickbooks::Model::CreditMemoChange
+      end
+    end
+  end
+end

data/lib/quickbooks/service/customer.rb

@@ -0,0 +1,18 @@
+module Quickbooks
+  module Service
+    class Customer < BaseService
+
+      def delete(customer)
+        customer.active = false
+        update(customer, :sparse => true)
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::Customer
+      end
+
+    end
+  end
+end

data/lib/quickbooks/service/customer_change.rb

@@ -0,0 +1,16 @@
+module Quickbooks
+  module Service
+    class CustomerChange < ChangeService
+
+      private
+
+      def entity
+        "Customer"
+      end
+
+      def model
+        Quickbooks::Model::CustomerChange
+      end
+    end
+  end
+end

data/lib/quickbooks/service/department.rb

@@ -0,0 +1,23 @@
+module Quickbooks
+  module Service
+    class Department < BaseService
+
+      def update(entity, options = {})
+        raise Quickbooks::InvalidModelException.new('Department sparse update is not supported by Intuit at this time') if options[:sparse] && options[:sparse] == true
+        super(entity, options)
+      end
+
+      def delete(department)
+        department.active = false
+        update(department, :sparse => false)
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::Department
+      end
+
+    end
+  end
+end

data/lib/quickbooks/service/deposit.rb

@@ -0,0 +1,16 @@
+module Quickbooks
+  module Service
+    class Deposit < BaseService
+
+      def delete(payment)
+        delete_by_query_string(payment)
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::Deposit
+      end
+    end
+  end
+end

data/lib/quickbooks/service/employee.rb

@@ -0,0 +1,24 @@
+module Quickbooks
+  module Service
+    class Employee < BaseService
+
+      # override update as sparse is not supported
+      def update(entity, options = {})
+        raise Quickbooks::InvalidModelException.new('Employee sparse update is not supported by Intuit at this time') if options[:sparse] && options[:sparse] == true
+        super(entity, options)
+      end
+
+      def delete(employee)
+        employee.active = false
+        update(employee, :sparse => false)
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::Employee
+      end
+
+    end
+  end
+end

data/lib/quickbooks/service/estimate.rb

@@ -0,0 +1,22 @@
+module Quickbooks
+  module Service
+    class Estimate < BaseService
+
+      def delete(estimate)
+        delete_by_query_string(estimate)
+      end
+      
+      def pdf(estimate)
+        url = "#{url_for_resource(model::REST_RESOURCE)}/#{estimate.id}/pdf"
+        response = do_http_raw_get(url, {}, {'Accept' => 'application/pdf'})
+        response.plain_body
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::Estimate
+      end
+    end
+  end
+end

data/lib/quickbooks/service/exchange_rate.rb

@@ -0,0 +1,25 @@
+module Quickbooks
+  module Service
+    class ExchangeRate < BaseService
+
+      def fetch_by_currency(source_currency_code, as_of_date = nil)
+        url = url_for_resource(model::REST_RESOURCE)
+        params = { sourcecurrencycode: source_currency_code }
+        params[:asofdate] = as_of_date unless as_of_date.nil?
+
+        response = do_http_get(url, params)
+        if response.code.to_i == 200
+          model.from_xml(parse_singular_entity_response(model, response.plain_body))
+        else
+          nil
+        end
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::ExchangeRate
+      end
+    end
+  end
+end

data/lib/quickbooks/service/invoice.rb

@@ -0,0 +1,45 @@
+module Quickbooks
+  module Service
+    class Invoice < BaseService
+
+      def delete(invoice)
+        delete_by_query_string(invoice)
+      end
+
+      def send(invoice, email_address=nil)
+        query = email_address.present? ? "?sendTo=#{email_address}" : ""
+        url = "#{url_for_resource(model::REST_RESOURCE)}/#{invoice.id}/send#{query}"
+        response = do_http_post(url, "", {}, { 'Content-Type' => 'application/octet-stream' })
+        if response.code.to_i == 200
+          model.from_xml(parse_singular_entity_response(model, response.plain_body))
+        else
+          nil
+        end
+      end
+
+      def pdf(invoice)
+        url = "#{url_for_resource(model::REST_RESOURCE)}/#{invoice.id}/pdf"
+        response = do_http_raw_get(url, {}, {'Accept' => 'application/pdf'})
+        response.plain_body
+      end
+
+      def void(invoice, options = {})
+        url = "#{url_for_resource(model::REST_RESOURCE)}?operation=void"
+
+        xml = invoice.to_xml_ns(options)
+        response = do_http_post(url, valid_xml_document(xml))
+        if response.code.to_i == 200
+          model.from_xml(parse_singular_entity_response(model, response.plain_body))
+        else
+          false
+        end
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::Invoice
+      end
+    end
+  end
+end

data/lib/quickbooks/service/invoice_change.rb

@@ -0,0 +1,16 @@
+module Quickbooks
+  module Service
+    class InvoiceChange < ChangeService
+
+      private
+
+      def entity
+        "Invoice"
+      end
+
+      def model
+        Quickbooks::Model::InvoiceChange
+      end
+    end
+  end
+end

data/lib/quickbooks/service/item.rb

@@ -0,0 +1,32 @@
+module Quickbooks
+  module Service
+    class Item < BaseService
+
+      def delete(item)
+        item.active = false
+        update(item, :sparse => true)
+      end
+
+      def url_for_resource(resource)
+        url = super(resource)
+        "#{url}?minorversion=#{Quickbooks::Model::Item::MINORVERSION}"
+      end
+
+      def fetch_by_id(id, params = {})
+        url = "#{url_for_base}/item/#{id}?minorversion=#{Quickbooks::Model::Item::MINORVERSION}"
+        fetch_object(model, url, params)
+      end
+
+      def url_for_query(query = nil, start_position = 1, max_results = 20, options = {})
+        url = super(query, start_position, max_results, options)
+        "#{url}&minorversion=#{Quickbooks::Model::Item::MINORVERSION}"
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::Item
+      end
+    end
+  end
+end

data/lib/quickbooks/service/item_change.rb

@@ -0,0 +1,16 @@
+module Quickbooks
+  module Service
+    class ItemChange < ChangeService
+
+      private
+
+      def entity
+        "Item"
+      end
+
+      def model
+        Quickbooks::Model::ItemChange
+      end
+    end
+  end
+end

data/lib/quickbooks/service/journal_entry.rb

@@ -0,0 +1,16 @@
+module Quickbooks
+  module Service
+    class JournalEntry < BaseService
+
+      def delete(entry)
+        delete_by_query_string(entry)
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::JournalEntry
+      end
+    end
+  end
+end

data/lib/quickbooks/service/payment.rb

@@ -0,0 +1,29 @@
+module Quickbooks
+  module Service
+    class Payment < BaseService
+
+      def delete(payment)
+        delete_by_query_string(payment)
+      end
+
+      def void(entity, options = {})
+        raise Quickbooks::InvalidModelException.new(entity.errors.full_messages.join(',')) unless entity.valid?
+        xml = entity.to_xml_ns(options)
+        url = "#{url_for_resource(model::REST_RESOURCE)}?include=void"
+
+        response = do_http_post(url, valid_xml_document(xml), {})
+        if response.code.to_i == 200
+          model.from_xml(parse_singular_entity_response(model, response.plain_body))
+        else
+          false
+        end
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::Payment
+      end
+    end
+  end
+end

data/lib/quickbooks/service/payment_change.rb

@@ -0,0 +1,16 @@
+module Quickbooks
+  module Service
+    class PaymentChange < ChangeService
+
+      private
+
+      def entity
+        "Payment"
+      end
+
+      def model
+        Quickbooks::Model::PaymentChange
+      end
+    end
+  end
+end

data/lib/quickbooks/service/payment_method.rb

@@ -0,0 +1,30 @@
+module Quickbooks
+  module Service
+    class PaymentMethod < BaseService
+
+      def fetch_by_name(name)
+        self.query(search_name_query(name)).entries.first
+      end
+
+      def search_name_query(name)
+        "SELECT * FROM PaymentMethod WHERE Name = '#{name}'"
+      end
+
+      def update(entity, options = {})
+        raise Quickbooks::InvalidModelException.new('Payment Method sparse update is not supported by Intuit at this time') if options[:sparse] && options[:sparse] == true
+        super(entity, options)
+      end
+
+      def delete(department)
+        department.active = false
+        update(department, :sparse => false)
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::PaymentMethod
+      end
+    end
+  end
+end

data/lib/quickbooks/service/preferences.rb

@@ -0,0 +1,12 @@
+module Quickbooks
+  module Service
+    class Preferences < BaseService
+
+      private
+      
+      def model
+        Quickbooks::Model::Preferences
+      end
+    end
+  end
+end

data/lib/quickbooks/service/purchase.rb

@@ -0,0 +1,16 @@
+module Quickbooks
+  module Service
+    class Purchase < BaseService
+
+      def delete(purchase)
+        delete_by_query_string(purchase)
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::Purchase
+      end
+    end
+  end
+end

data/lib/quickbooks/service/purchase_order.rb

@@ -0,0 +1,16 @@
+module Quickbooks
+  module Service
+    class PurchaseOrder < BaseService
+
+      def delete(purchase_order)
+        delete_by_query_string(purchase_order)
+      end
+
+    private
+
+      def model
+        Quickbooks::Model::PurchaseOrder
+      end
+    end
+  end
+end

data/lib/quickbooks/service/refund_receipt.rb

@@ -0,0 +1,16 @@
+module Quickbooks
+  module Service
+    class RefundReceipt < BaseService
+
+      def delete(refund_receipt)
+        delete_by_query_string(refund_receipt)
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::RefundReceipt
+      end
+    end
+  end
+end

data/lib/quickbooks/service/refund_receipt_change.rb

@@ -0,0 +1,16 @@
+module Quickbooks
+  module Service
+    class RefundReceiptChange < ChangeService
+
+      private
+
+      def entity
+        "RefundReceipt"
+      end
+
+      def model
+        Quickbooks::Model::RefundReceiptChange
+      end
+    end
+  end
+end

data/lib/quickbooks/service/reports.rb

@@ -0,0 +1,33 @@
+# Docs: https://developer.intuit.com/docs/0100_accounting/0400_references/reports
+module Quickbooks
+  module Service
+    class Reports < BaseService
+
+      def url_for_query(which_report = 'BalanceSheet', date_macro = 'This Fiscal Year-to-date', options = {})
+        if(options == {})
+          return "#{url_for_base}/reports/#{which_report}?date_macro=#{URI.encode_www_form_component(date_macro)}"
+        else
+          options_string = ""
+          options.each do |key, value|
+            options_string += "#{key}=#{value}&"
+          end
+          options_string = options_string[0..-2]
+          options_string.gsub!(/\s/,"%20")
+          return "#{url_for_base}/reports/#{which_report}?#{options_string}"
+        end
+      end
+
+      def query(object_query = 'BalanceSheet', date_macro = 'This Fiscal Year-to-date', options = {})
+        do_http_get(url_for_query(object_query, date_macro, options))
+        model.new(:xml => @last_response_xml)
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::Report
+      end
+
+    end
+  end
+end

data/lib/quickbooks/service/responses/methods.rb

@@ -0,0 +1,17 @@
+module Quickbooks
+  module Service
+    module Responses
+      module Methods
+
+        def body
+          raise "implement me"
+        end
+
+        def code
+          raise "implement me"
+        end
+
+      end
+    end
+  end
+end

data/lib/quickbooks/service/responses/oauth1_http_response.rb

@@ -0,0 +1,42 @@
+module Quickbooks
+  module Service
+    module Responses
+
+      class OAuth1HttpResponse < OAuthHttpResponse
+
+        attr_accessor :real_response
+
+        # net/http response
+        def initialize(response)
+          @real_response = response
+        end
+
+        def version
+          1
+        end
+
+        def code
+          @real_response.code.to_i
+        end
+
+        def plain_body
+          if @real_response.respond_to?(:plain_body)
+            @real_response.plain_body
+          else
+            nil
+          end
+        end
+
+        def headers
+          if @real_response.respond_to?(:headers)
+            @real_response.headers
+          else
+            nil
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/quickbooks/service/responses/oauth2_http_response.rb

@@ -0,0 +1,43 @@
+module Quickbooks
+  module Service
+    module Responses
+
+      class OAuth2HttpResponse
+        include Quickbooks::Service::Responses::Methods
+
+        attr_accessor :real_response
+
+        # response : Faraday response
+        def initialize(response)
+          @real_response = response
+        end
+
+        def version
+          2
+        end
+
+        def body
+          @real_response.body
+        end
+
+        def plain_body
+          body
+        end
+
+        def code
+          @real_response.status.to_i
+        end
+
+        def headers
+          if @real_response.respond_to?(:headers)
+            @real_response.headers
+          else
+            nil
+          end
+        end
+
+      end
+
+    end
+  end
+end