quickbooks-ruby 0.4.0 → 1.0.16

data/lib/quickbooks/service/batch.rb

@@ -3,7 +3,7 @@ module Quickbooks
     class Batch < BaseService
 
       def make_request(entity, options = {})
-        response = do_http_post(url_for_resource('batch'), valid_xml_document(entity.to_xml_ns))
+        response = do_http_post(url_for_resource('batch'), valid_xml_document(entity.to_xml_ns), options[:query])
         Quickbooks::Model::BatchResponse.from_xml(response.plain_body)
       end
     end

data/lib/quickbooks/service/change_data_capture.rb

@@ -0,0 +1,24 @@
+module Quickbooks
+  module Service
+    class ChangeDataCapture < BaseService
+
+      def url_for_query(entity_list, query=nil)
+        q = entity_list.join(",")
+        q = "#{q}&#{query}" if query.present?
+        return "#{url_for_base}/cdc?entities=#{q}"
+      end
+
+      def since(entity_list, timestamp)
+        do_http_get(url_for_query(entity_list, "changedSince=#{URI.encode_www_form_component(timestamp.iso8601)}"))
+        model.new(:xml => @last_response_xml)
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::ChangeDataCapture
+      end
+
+    end
+  end
+end

data/lib/quickbooks/service/company_currency.rb

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

data/lib/quickbooks/service/credit_memo.rb

@@ -6,6 +6,12 @@ module Quickbooks
         delete_by_query_string(credit_memo)
       end
 
+      def pdf(credit_memo)
+        url = "#{url_for_resource(model::REST_RESOURCE)}/#{credit_memo.id}/pdf"
+        response = do_http_raw_get(url, {}, {'Accept' => 'application/pdf'})
+        response.plain_body
+      end
+
       private
 
       def model

data/lib/quickbooks/service/custom_field.rb

@@ -0,0 +1,20 @@
+module Quickbooks
+  module Service
+    class CustomField < BaseService
+
+      def delete(customer_type)
+        raise Quickbooks::UnsupportedOperation.new('Deleting CustomerType is not supported by Intuit')
+      end
+
+      def create(customer_type)
+        raise Quickbooks::UnsupportedOperation.new('Creating/updating CustomerType is not supported by Intuit')
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::CustomField
+      end
+    end
+  end
+end

data/lib/quickbooks/service/customer.rb

@@ -7,6 +7,11 @@ module Quickbooks
         update(customer, :sparse => true)
       end
 
+      def fetch_by_id(id, params = {})
+        url = "#{url_for_base}/customer/#{id}"
+        fetch_object(model, url, params)
+      end
+
       private
 
       def model

data/lib/quickbooks/service/customer_type.rb

@@ -0,0 +1,20 @@
+module Quickbooks
+  module Service
+    class CustomerType < BaseService
+
+      def delete(customer_type)
+        raise Quickbooks::UnsupportedOperation.new('Deleting CustomerType is not supported by Intuit')
+      end
+
+      def create(customer_type)
+        raise Quickbooks::UnsupportedOperation.new('Creating/updating CustomerType is not supported by Intuit')
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::CustomerType
+      end
+    end
+  end
+end

data/lib/quickbooks/service/estimate.rb

@@ -5,6 +5,12 @@ module Quickbooks
       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
 

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

@@ -6,10 +6,15 @@ module Quickbooks
         delete_by_query_string(invoice)
       end
 
+      def fetch_by_id(id, params = {})
+        url = "#{url_for_base}/invoice/#{id}"
+        fetch_object(model, url, params)
+      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,{})
+        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
@@ -17,6 +22,24 @@ module Quickbooks
         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

data/lib/quickbooks/service/item.rb

@@ -7,6 +7,11 @@ module Quickbooks
         update(item, :sparse => true)
       end
 
+      def fetch_by_id(id, params = {})
+        url = "#{url_for_base}/item/#{id}"
+        fetch_object(model, url, params)
+      end
+
       private
 
       def model

data/lib/quickbooks/service/payment.rb

@@ -6,6 +6,19 @@ module Quickbooks
         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

data/lib/quickbooks/service/preferences.rb

@@ -3,7 +3,7 @@ module Quickbooks
     class Preferences < BaseService
 
       private
-      
+
       def model
         Quickbooks::Model::Preferences
       end

data/lib/quickbooks/service/purchase_change.rb

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

data/lib/quickbooks/service/purchase_order.rb

@@ -6,6 +6,22 @@ module Quickbooks
         delete_by_query_string(purchase_order)
       end
 
+      def fetch_by_id(id, params = {})
+        url = "#{url_for_base}/purchaseorder/#{id}?minorversion=#{Quickbooks.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.minorversion}"
+      end
+
+      def pdf(purchase_order)
+        url = "#{url_for_resource(model::REST_RESOURCE)}/#{purchase_order.id}/pdf"
+        response = do_http_raw_get(url, {}, {'Accept' => 'application/pdf'})
+        response.plain_body
+      end
+
     private
 
       def model

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/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/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

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

@@ -0,0 +1,17 @@
+module Quickbooks
+  module Service
+    module Responses
+
+      # This class just proxies and returns a wrapped response so that callers
+      # can invoke a common interface
+      class OAuthHttpResponse
+
+        def self.wrap(response)
+          Quickbooks::Service::Responses::OAuth2HttpResponse.new(response)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/quickbooks/service/sales_receipt.rb

@@ -6,6 +6,36 @@ module Quickbooks
         delete_by_query_string(sales_receipt)
       end
 
+      def pdf(sales_receipt)
+        url = "#{url_for_resource(model::REST_RESOURCE)}/#{sales_receipt.id}/pdf"
+        response = do_http_raw_get(url, {}, {'Accept' => 'application/pdf'})
+        response.plain_body
+      end
+
+      def send(sr, email_address=nil)
+        query = email_address.present? ? "?sendTo=#{email_address}" : ""
+        url = "#{url_for_resource(model::REST_RESOURCE)}/#{sr.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 void(sales_receipt, options = {})
+        raise Quickbooks::InvalidModelException.new(sales_receipt.errors.full_messages.join(',')) unless sales_receipt.valid?
+        xml = sales_receipt.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

data/lib/quickbooks/service/service_crud.rb

@@ -6,6 +6,15 @@ module Quickbooks
         fetch_collection(object_query, model, options)
       end
 
+      # fetch all records, returns an array of models
+      def all(object_query=nil, options={})
+        collection = []
+        self.query_in_batches(object_query, options) do |batch|
+          collection << batch.entries
+        end
+        collection.flatten
+      end
+
       def query_in_batches(object_query=nil, options={})
         page = 0
         per_page = options.delete(:per_page) || 1_000
@@ -16,6 +25,18 @@ module Quickbooks
         end until results.count < per_page
       end
 
+      def exists?(field, selector, options={})
+        find_by(field, selector, options).count > 0
+      end
+
+      def find_by(field, selector, options={})
+        if field.class == Symbol
+          field = field.to_s.camelcase
+        end
+        q = "select * from %s where %s = '%s'" % [model.resource_for_singular, field, selector]
+        self.query(q, options)
+      end
+
       def fetch_by_id(id, params = {})
         url = "#{url_for_resource(model.resource_for_singular)}/#{id}"
         fetch_object(model, url, params)