quickbooks-ruby 0.4.0 → 1.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cd738a2e9e6bfa63ccf460226aa60dfe3688713d
-  data.tar.gz: e91dc8fc720d196c8075fe706667ec8c6c657e24
+SHA256:
+  metadata.gz: 80fd943e9fb98498f7b52adde6510420661a52096e86332e019b03a51e4485e5
+  data.tar.gz: c259acc229c14cfd586d670ed58f273e1d4b0d6dd81f0e2eddff56b4cc93e6f0
 SHA512:
-  metadata.gz: c466d28cb539140345cddc3a39bd11678b659c2150d98b6fcf8b8e04640fae6ab028f00de73bc17512a38af3f0baa03715973dc32463c2d475a9348b9a3ada63
-  data.tar.gz: e2dca1296eedcbf25578ec27e6eae67fd95ec1c382147cc5d554b7a44ddce2aa914be370c51391ad62cb71ddadfc04906e08084cf07f48a3518cfb854cbc8990
+  metadata.gz: '08b8913a1412ee319d017b833099c6ef88aab2aba9339849805915e7f090759f0a388d74e24b9b984db0f81016693310849ea1e0ef8b8e1ce3164ad68de7173d'
+  data.tar.gz: c05b69125cc0debc6364a0a9b82fa14703691e2e2dd5f5722ba34035c7b90c3da5a9b14dc164811f94ba35e63ac590daab1d923c0bf4bfa801818ff46799057a

data/lib/quickbooks-ruby.rb

@@ -6,13 +6,19 @@ require 'cgi'
 require 'uri'
 require 'date'
 require 'forwardable'
-require 'oauth'
+require 'oauth2'
 require 'net/http/post/multipart'
 require 'quickbooks/util/collection'
 require 'quickbooks/util/logging'
 require 'quickbooks/util/http_encoding_helper'
 require 'quickbooks/util/name_entity'
 require 'quickbooks/util/query_builder'
+require 'quickbooks/faraday/middleware/gzip'
+
+#== OAuth Responses
+require 'quickbooks/service/responses/oauth_http_response'
+require 'quickbooks/service/responses/methods'
+require 'quickbooks/service/responses/oauth2_http_response'
 
 #== Models
 require 'quickbooks/model/definition'
@@ -23,6 +29,7 @@ require 'quickbooks/model/base_reference'
 require 'quickbooks/model/document_numbering'
 require 'quickbooks/model/global_tax_calculation'
 require 'quickbooks/model/has_line_items'
+require 'quickbooks/model/name_value'
 require 'quickbooks/model/access_token_response'
 require 'quickbooks/model/meta_data'
 require 'quickbooks/model/class'
@@ -32,6 +39,7 @@ require 'quickbooks/model/attachable'
 require 'quickbooks/model/custom_field'
 require 'quickbooks/model/sales_item_line_detail'
 require 'quickbooks/model/sub_total_line_detail'
+require 'quickbooks/model/description_line_detail'
 require 'quickbooks/model/department'
 require 'quickbooks/model/discount_line_detail'
 require 'quickbooks/model/discount_override'
@@ -44,8 +52,11 @@ require 'quickbooks/model/tax_line'
 require 'quickbooks/model/transaction_tax_detail'
 require 'quickbooks/model/entity'
 require 'quickbooks/model/journal_entry_line_detail'
+require 'quickbooks/model/line_ex'
 require 'quickbooks/model/line'
 require 'quickbooks/model/journal_entry'
+require 'quickbooks/model/item_group_line'
+require 'quickbooks/model/item_group_detail'
 require 'quickbooks/model/item'
 require 'quickbooks/model/budget_line_item'
 require 'quickbooks/model/budget'
@@ -61,9 +72,12 @@ require 'quickbooks/model/email_address'
 require 'quickbooks/model/web_site_address'
 require 'quickbooks/model/physical_address'
 require 'quickbooks/model/invoice_line_item'
-require 'quickbooks/model/name_value'
+require 'quickbooks/model/invoice_group_line_detail'
 require 'quickbooks/model/company_info'
+require 'quickbooks/model/company_currency'
+require 'quickbooks/model/customer_type'
 require 'quickbooks/model/customer'
+require 'quickbooks/model/delivery_info'
 require 'quickbooks/model/sales_receipt'
 require 'quickbooks/model/payment'
 require 'quickbooks/model/payment_method'
@@ -76,6 +90,7 @@ require 'quickbooks/model/bill_payment_credit_card'
 require 'quickbooks/model/bill_payment'
 require 'quickbooks/model/vendor'
 require 'quickbooks/model/employee'
+require 'quickbooks/model/exchange_rate'
 require 'quickbooks/model/term'
 require 'quickbooks/model/markup_info'
 require 'quickbooks/model/group_line_detail'
@@ -86,8 +101,8 @@ require 'quickbooks/model/purchase'
 require 'quickbooks/model/purchase_order'
 require 'quickbooks/model/vendor_credit'
 require 'quickbooks/model/estimate'
-require 'quickbooks/model/delivery_info'
 require 'quickbooks/model/invoice'
+require 'quickbooks/model/effective_tax_rate'
 require 'quickbooks/model/tax_rate'
 require 'quickbooks/model/tax_rate_detail'
 require 'quickbooks/model/tax_rate_detail_line'
@@ -97,10 +112,10 @@ require 'quickbooks/model/tax_agency'
 require 'quickbooks/model/tax_service'
 require 'quickbooks/model/tax_code'
 require 'quickbooks/model/fault'
+require 'quickbooks/model/refund_receipt'
 require 'quickbooks/model/batch_request'
 require 'quickbooks/model/batch_response'
 require 'quickbooks/model/preferences'
-require 'quickbooks/model/refund_receipt'
 require 'quickbooks/model/change_model'
 require 'quickbooks/model/invoice_change'
 require 'quickbooks/model/customer_change'
@@ -109,7 +124,10 @@ require 'quickbooks/model/item_change'
 require 'quickbooks/model/report'
 require 'quickbooks/model/credit_memo_change'
 require 'quickbooks/model/payment_change'
-
+require 'quickbooks/model/purchase_change'
+require 'quickbooks/model/transfer'
+require 'quickbooks/model/change_data_capture'
+require 'quickbooks/model/refund_receipt_change'
 
 #== Services
 require 'quickbooks/service/service_crud'
@@ -120,10 +138,14 @@ require 'quickbooks/service/access_token'
 require 'quickbooks/service/class'
 require 'quickbooks/service/attachable'
 require 'quickbooks/service/company_info'
+require 'quickbooks/service/company_currency'
+require 'quickbooks/service/customer_type'
+require 'quickbooks/service/custom_field'
 require 'quickbooks/service/customer'
 require 'quickbooks/service/department'
 require 'quickbooks/service/invoice'
 require 'quickbooks/service/deposit'
+
 require 'quickbooks/service/item'
 require 'quickbooks/service/budget'
 require 'quickbooks/service/journal_entry'
@@ -135,6 +157,7 @@ require 'quickbooks/service/bill'
 require 'quickbooks/service/bill_payment'
 require 'quickbooks/service/vendor'
 require 'quickbooks/service/employee'
+require 'quickbooks/service/exchange_rate'
 require 'quickbooks/service/payment'
 require 'quickbooks/service/term'
 require 'quickbooks/service/time_activity'
@@ -159,11 +182,18 @@ require 'quickbooks/service/item_change'
 require 'quickbooks/service/reports'
 require 'quickbooks/service/credit_memo_change'
 require 'quickbooks/service/payment_change'
+require 'quickbooks/service/purchase_change'
+require 'quickbooks/service/transfer'
+require 'quickbooks/service/change_data_capture'
+require 'quickbooks/service/refund_receipt_change'
+
+# Register Faraday Middleware
+Faraday::Middleware.register_middleware :gzip => lambda { Gzip }
 
 module Quickbooks
   @@sandbox_mode = false
-
   @@logger = nil
+  @@minorversion = 47
 
   class << self
     def sandbox_mode
@@ -174,6 +204,14 @@ module Quickbooks
       @@sandbox_mode = sandbox_mode
     end
 
+    def minorversion=(v)
+      @@minorversion = v
+    end
+
+    def minorversion
+      @@minorversion
+    end
+
     def logger
       @@logger ||= ::Logger.new($stdout) # TODO: replace with a real log file
     end
@@ -203,16 +241,30 @@ module Quickbooks
     end
   end # << self
 
-  class InvalidModelException < StandardError; end
+  class Error < StandardError; end
+  class InvalidModelException < Error; end
+  class AuthorizationFailure < Error
+    attr_accessor :code, :detail, :type
 
-  class AuthorizationFailure < StandardError; end
-  class Forbidden < StandardError; end
+    def initialize(error_hash = {})
+      @code = error_hash[:code]
+      @detail = error_hash[:detail]
+      @type = error_hash[:type]
+      super(error_hash[:message])
+    end
+  end
+  class Forbidden < Error; end
+  class NotFound < Error; end
+  class RequestTooLarge < Error; end
+  class ThrottleExceeded < Forbidden; end
+  class TooManyRequests < Error; end
+  class ServiceUnavailable < Error; end
+  class MissingRealmError < Error; end
+  class UnsupportedOperation < Error; end
 
-  class ServiceUnavailable < StandardError; end
-  class MissingRealmError < StandardError; end
+  class IntuitRequestException < Error
+    attr_accessor :message, :code, :detail, :type, :intuit_tid, :request_xml, :request_json
 
-  class IntuitRequestException < StandardError
-    attr_accessor :message, :code, :detail, :type, :request_xml, :request_json
     def initialize(msg)
       self.message = msg
       super(msg)

data/lib/quickbooks/faraday/middleware/gzip.rb

@@ -0,0 +1,74 @@
+# https://github.com/lostisland/faraday_middleware/blob/master/lib/faraday_middleware/gzip.rb
+
+require 'faraday'
+
+# Middleware to automatically decompress response bodies. If the
+# "Accept-Encoding" header wasn't set in the request, this sets it to
+# "gzip,deflate" and appropriately handles the compressed response from the
+# server. This resembles what Ruby 1.9+ does internally in Net::HTTP#get.
+#
+# This middleware is NOT necessary when these adapters are used:
+# - net_http on Ruby 1.9+
+# - net_http_persistent on Ruby 2.0+
+# - em_http
+class Gzip < Faraday::Middleware
+  dependency 'zlib'
+
+  ACCEPT_ENCODING = 'Accept-Encoding'.freeze
+  CONTENT_ENCODING = 'Content-Encoding'.freeze
+  CONTENT_LENGTH = 'Content-Length'.freeze
+  SUPPORTED_ENCODINGS = 'gzip,deflate,br'.freeze
+  RUBY_ENCODING = '1.9'.respond_to?(:force_encoding)
+
+  def call(env)
+    env[:request_headers][ACCEPT_ENCODING] ||= SUPPORTED_ENCODINGS
+    @app.call(env).on_complete do |response_env|
+      break if response_env[:response_headers].nil?
+
+      case response_env[:response_headers][CONTENT_ENCODING]
+      when 'gzip'
+        reset_body(response_env, &method(:uncompress_gzip))
+      when 'deflate'
+        reset_body(response_env, &method(:inflate))
+      when 'br'
+        reset_body(response_env, &method(:brotli_inflate))
+      end
+    end
+  end
+
+  def reset_body(env)
+    env[:body] = yield(env[:body])
+    env[:response_headers].delete(CONTENT_ENCODING)
+    env[:response_headers][CONTENT_LENGTH] = env[:body].length
+  end
+
+  def uncompress_gzip(body)
+    io = StringIO.new(body)
+    gzip_reader = if RUBY_ENCODING
+      Zlib::GzipReader.new(io, :encoding => 'ASCII-8BIT')
+    else
+      Zlib::GzipReader.new(io)
+    end
+    gzip_reader.read
+  end
+
+  def inflate(body)
+    # Inflate as a DEFLATE (RFC 1950+RFC 1951) stream
+    Zlib::Inflate.inflate(body)
+  rescue Zlib::DataError
+    # Fall back to inflating as a "raw" deflate stream which
+    # Microsoft servers return
+    inflate = Zlib::Inflate.new(-Zlib::MAX_WBITS)
+    begin
+      inflate.inflate(body)
+    ensure
+      inflate.close
+    end
+  end
+
+  def brotli_inflate(body)
+    self.class.dependency 'brotli'
+
+    Brotli.inflate(body)
+  end
+end

data/lib/quickbooks/model/base_model.rb

@@ -2,6 +2,7 @@ module Quickbooks
   module Model
     class BaseModel
       include Definition
+      include ActiveModel::AttributeMethods
       include ActiveModel::Validations
       include Validator
       include ROXML
@@ -27,6 +28,14 @@ module Quickbooks
         step2
       end
 
+      def as_json(options = nil)
+        options = {} if options.nil?
+        except_conditions = ["roxml_references"]
+        except_conditions << options[:except]
+        options[:except] = except_conditions.flatten.uniq.compact
+        super(options)
+      end
+
       def to_xml_ns(options = {})
         to_xml_inject_ns(self.class::XML_NODE, options)
       end
@@ -46,7 +55,7 @@ module Quickbooks
       def inspect
         # it would be nice if we could inspect all the children,
         # but it's likely to blow the stack in some cases
-        "#<#{self.class} " + 
+        "#<#{self.class} " +
         "#{attributes.map{|k,v| "#{k}: #{v.nil? ? 'nil' : v.to_s }"}.join ", "}>"
       end
       class << self
@@ -78,7 +87,9 @@ module Quickbooks
           references = args.empty? ? reference_attrs : args
 
           references.each do |attribute|
-            method_name = "#{attribute.to_s.gsub('_ref', '_id')}=".to_sym
+            last_index = attribute.to_s.rindex('_ref')
+            field_name = !last_index.nil? ? attribute.to_s.slice(0, last_index) : attribute
+            method_name = "#{field_name}_id=".to_sym
             unless instance_methods(false).include?(method_name)
               method_definition = <<-METH
               def #{method_name}(id)

data/lib/quickbooks/model/batch_request.rb

@@ -8,16 +8,21 @@ class Quickbooks::Model::BatchRequest < Quickbooks::Model::BaseModel
     xml_accessor :bId, :from => "@bId"
 
     # Supported Entities
-    xml_accessor :item, from: "Item", as: Quickbooks::Model::Item
     xml_accessor :account, from: "Account", as: Quickbooks::Model::Account
-    xml_accessor :invoice, from: "Invoice", as: Quickbooks::Model::Invoice
-    xml_accessor :customer, from: "Customer", as: Quickbooks::Model::Customer
-    xml_accessor :bill, from: "Bill", as: Quickbooks::Model::Bill
-    xml_accessor :sales_receipt, from: "SalesReceipt", as: Quickbooks::Model::SalesReceipt
     xml_accessor :bill_payment, from: "BillPayment", as: Quickbooks::Model::BillPayment
-    xml_accessor :purchase, from: "Purchase", as: Quickbooks::Model::Purchase
+    xml_accessor :bill, from: "Bill", as: Quickbooks::Model::Bill
     xml_accessor :credit_memo, from: "CreditMemo", as: Quickbooks::Model::CreditMemo
+    xml_accessor :customer, from: "Customer", as: Quickbooks::Model::Customer
+    xml_accessor :invoice, from: "Invoice", as: Quickbooks::Model::Invoice
+    xml_accessor :item, from: "Item", as: Quickbooks::Model::Item
+    xml_accessor :journal_entry, from: "JournalEntry", as: Quickbooks::Model::JournalEntry
     xml_accessor :payment, from: "Payment", as: Quickbooks::Model::Payment
+    xml_accessor :purchase_order, from: "PurchaseOrder", as: Quickbooks::Model::PurchaseOrder
+    xml_accessor :purchase, from: "Purchase", as: Quickbooks::Model::Purchase
+    xml_accessor :refund_receipt, from: "RefundReceipt", as: Quickbooks::Model::RefundReceipt
+    xml_accessor :sales_receipt, from: "SalesReceipt", as: Quickbooks::Model::SalesReceipt
+    xml_accessor :time_activity, from: "TimeActivity", as: Quickbooks::Model::TimeActivity
+    xml_accessor :vendor, from: "Vendor", as: Quickbooks::Model::Vendor
   end
 
   XML_COLLECTION_NODE = "IntuitBatchRequest"

data/lib/quickbooks/model/batch_response.rb

@@ -7,16 +7,21 @@ class Quickbooks::Model::BatchResponse < Quickbooks::Model::BaseModel
     xml_accessor :fault, :from => 'Fault', :as => Quickbooks::Model::Fault
 
     # Supported Entities
-    xml_accessor :item, from: "Item", as: Quickbooks::Model::Item
     xml_accessor :account, from: "Account", as: Quickbooks::Model::Account
-    xml_accessor :invoice, from: "Invoice", as: Quickbooks::Model::Invoice
-    xml_accessor :customer, from: "Customer", as: Quickbooks::Model::Customer
-    xml_accessor :bill, from: "Bill", as: Quickbooks::Model::Bill
-    xml_accessor :sales_receipt, from: "SalesReceipt", as: Quickbooks::Model::SalesReceipt
     xml_accessor :bill_payment, from: "BillPayment", as: Quickbooks::Model::BillPayment
-    xml_accessor :purchase, from: "Purchase", as: Quickbooks::Model::Purchase
+    xml_accessor :bill, from: "Bill", as: Quickbooks::Model::Bill
     xml_accessor :credit_memo, from: "CreditMemo", as: Quickbooks::Model::CreditMemo
+    xml_accessor :customer, from: "Customer", as: Quickbooks::Model::Customer
+    xml_accessor :invoice, from: "Invoice", as: Quickbooks::Model::Invoice
+    xml_accessor :item, from: "Item", as: Quickbooks::Model::Item
+    xml_accessor :journal_entry, from: "JournalEntry", as: Quickbooks::Model::JournalEntry
     xml_accessor :payment, from: "Payment", as: Quickbooks::Model::Payment
+    xml_accessor :purchase_order, from: "PurchaseOrder", as: Quickbooks::Model::PurchaseOrder
+    xml_accessor :purchase, from: "Purchase", as: Quickbooks::Model::Purchase
+    xml_accessor :refund_receipt, from: "RefundReceipt", as: Quickbooks::Model::RefundReceipt
+    xml_accessor :sales_receipt, from: "SalesReceipt", as: Quickbooks::Model::SalesReceipt
+    xml_accessor :time_activity, from: "TimeActivity", as: Quickbooks::Model::TimeActivity
+    xml_accessor :vendor, from: "Vendor", as: Quickbooks::Model::Vendor
 
     def fault?
       fault

data/lib/quickbooks/model/bill.rb

@@ -16,9 +16,12 @@ module Quickbooks
       xml_accessor :department_ref, :from => 'DepartmentRef', :as => BaseReference
 
       xml_accessor :line_items, :from => 'Line', :as => [BillLineItem]
+      xml_accessor :txn_tax_detail, :from => 'TxnTaxDetail', :as => TransactionTaxDetail
 
       xml_accessor :private_note, :from => 'PrivateNote'
 
+      xml_accessor :linked_transactions, :from => 'LinkedTxn', :as => [LinkedTransaction]
+
       xml_accessor :vendor_ref, :from => 'VendorRef', :as => BaseReference
       xml_accessor :payer_ref, :from => 'PayerRef', :as => BaseReference
       xml_accessor :sales_term_ref, :from => 'SalesTermRef', :as => BaseReference

data/lib/quickbooks/model/change_data_capture.rb

@@ -0,0 +1,50 @@
+module Quickbooks
+  module Model
+    class ChangeDataCapture < BaseModel
+
+      attr_accessor :xml
+
+      TYPES = ["Bill", "BillPayment", "CreditMemo", "Deposit", "Invoice", "JournalEntry", "Payment",
+        "Purchase", "RefundReceipt", "SalesReceipt", "PurchaseOrder", "VendorCredit", "Transfer",
+        "Estimate", "Account", "Budget", "Class", "Customer", "Department", "Employee", "Item", 
+        "PaymentMethod", "Term", "Vendor"]
+
+      def all_types
+         data = {}
+         TYPES.each do |entity|
+           if xml.css(entity).first != nil
+             data[entity] = all_of_type(entity)
+           end
+         end
+         data
+      end
+
+      # time when refresh was requests from cdc/ endpoiint
+      # more information @here - https://developer.intuit.com/app/developer/qbo/docs/develop/explore-the-quickbooks-online-api/change-data-capture#using-change-data-capture
+      #
+      def time
+        attribute = xml.root.attribute('time')
+        attribute.value if attribute
+      end
+
+      private
+
+      def all_of_type(entity)
+        parse_block(xml.css(entity).first.parent, entity)
+      end
+
+      def parse_block(node, entity)
+        model = "Quickbooks::Model::#{entity}".constantize
+        models = []
+        all_items = node.css(entity).map do |item|
+          if item.attribute("status").try(:value) == "Deleted"
+            Quickbooks::Model::ChangeModel.from_xml(item)
+          else
+            model.from_xml(item)
+          end
+        end
+      end
+
+    end
+  end
+end