quickbooks-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22455ec12ce95cceccc04131008bbcee20de080b
+  data.tar.gz: 0e87c10779104d91aa8a100297c738cb905861b0
+SHA512:
+  metadata.gz: 74ba6b76bab8e057cb7dc3c6a706e1e70226f4459bfd78e6ac6308f752129f225e5cdb77546216d54e79d0f6d1f8e7abecc880da46cf070f7675c539598a3eef
+  data.tar.gz: 81652a925524f36c044d79e9c7f8bc9c33b739130cafbc6faf757376dd6969868ecc0cb04f36294758d9abcd0b058aa59485e59cac531354bb9806c1d61cb8f5

data/lib/quickbooks.rb

@@ -0,0 +1,81 @@
+require 'roxml'
+require 'logger'
+require 'nokogiri'
+require 'logger'
+require 'active_model'
+require 'cgi'
+require 'date'
+require 'forwardable'
+require 'oauth'
+require 'quickbooks/util/logging'
+
+#== Models
+require 'quickbooks/model/base_model'
+require 'quickbooks/model/meta_data'
+require 'quickbooks/model/custom_field'
+require 'quickbooks/model/invoice_item_ref'
+require 'quickbooks/model/sales_item_line_detail'
+require 'quickbooks/model/sub_total_line_detail'
+require 'quickbooks/model/customer_ref'
+require 'quickbooks/model/discount_override'
+require 'quickbooks/model/payment_line_detail'
+require 'quickbooks/model/item'
+
+
+require 'quickbooks/model/telephone_number'
+require 'quickbooks/model/email_address'
+require 'quickbooks/model/web_site_address'
+require 'quickbooks/model/physical_address'
+require 'quickbooks/model/linked_transaction'
+require 'quickbooks/model/invoice_line_item'
+require 'quickbooks/model/invoice'
+require 'quickbooks/model/customer'
+
+#== Services
+require 'quickbooks/service/base_service'
+require 'quickbooks/service/service_crud'
+require 'quickbooks/service/customer'
+require 'quickbooks/service/invoice'
+require 'quickbooks/service/item'
+
+class InvalidModelException < StandardError; end
+
+module Quickbooks
+  @@logger = nil
+
+  class << self
+    def logger
+      @@logger ||= ::Logger.new($stdout) # TODO: replace with a real log file
+    end
+
+    def logger=(logger)
+      @@logger = logger
+    end
+
+    # set logging on or off
+    attr_writer :log
+
+    # Returns whether to log. Defaults to 'false'.
+    def log?
+      @log ||= false
+    end
+
+    def log(msg)
+      if log?
+        logger.info(msg)
+        logger.flush if logger.respond_to?(:flush)
+      end
+    end
+  end # << self
+
+  class Collection
+    attr_accessor :entries
+
+    # Legacy Attributes (v2)
+    attr_accessor :count, :current_page
+
+    # v3 Attributes
+    attr_accessor :start_position, :max_results, :total_count
+  end
+
+end

data/lib/quickbooks/http_encoding_helper.rb

@@ -0,0 +1,49 @@
+# Intended to extend the Net::HTTP response object
+# and adds support for decoding gzip and deflate encoded pages
+#
+# Author: Jason Stirk <http://griffin.oobleyboo.com>
+# Home: http://griffin.oobleyboo.com/projects/http_encoding_helper
+# Created: 5 September 2007
+# Last Updated: 23 November 2007
+#
+# Usage:
+#
+# require 'net/http'
+# require 'http_encoding_helper'
+# headers={'Accept-Encoding' => 'gzip, deflate' }
+# http = Net::HTTP.new('griffin.oobleyboo.com', 80)
+# http.start do |h|
+#   request = Net::HTTP::Get.new('/', headers)
+#   response = http.request(request)
+#   content=response.plain_body     # Method from our library
+#   puts "Transferred: #{response.body.length} bytes"
+#   puts "Compression: #{response['content-encoding']}"
+#   puts "Extracted: #{response.plain_body.length} bytes"  
+# end
+#	
+
+require 'zlib'
+require 'stringio'
+
+class Net::HTTPResponse
+  # Return the uncompressed content
+  def plain_body
+    encoding=self['content-encoding']
+    content=nil
+    if encoding then
+      case encoding
+        when 'gzip'
+          i=Zlib::GzipReader.new(StringIO.new(self.body))
+          content=i.read
+        when 'deflate'
+          i=Zlib::Inflate.new
+          content=i.inflate(self.body)
+        else
+          raise "Unknown encoding - #{encoding}"
+      end
+    else
+      content=self.body
+    end
+    return content
+  end
+end

data/lib/quickbooks/model/base_model.rb

@@ -0,0 +1,41 @@
+module Quickbooks
+  module Model
+    class BaseModel
+      include ActiveModel::Validations
+      include ROXML
+      xml_convention :camelcase
+
+      # ROXML doesnt insert the namespaces into generated XML so we need to do it ourselves
+      # insert the static namespaces in the first opening tag that matches the +model_name+
+      def to_xml_inject_ns(model_name, options = {})
+        s = StringIO.new
+        xml = to_xml(options).write_to(s, :indent => 0, :indent_text => '')
+        destination_name = options.fetch(:destination_name, nil)
+        destination_name ||= model_name
+
+        sparse = options.fetch(:sparse, false)
+        sparse_string = %{sparse="#{sparse}"}
+        step1 = s.string.sub("<#{model_name}>", "<#{destination_name} #{Quickbooks::Service::BaseService::XML_NS} #{sparse_string}>")
+        step2 = step1.sub("</#{model_name}>", "</#{destination_name}>")
+        step2
+      end
+
+      def to_xml_ns(options = {})
+        to_xml_inject_ns(self.class::XML_NODE, options)
+      end
+
+      class << self
+
+        # These can be over-ridden in each model object as needed
+        def resource_for_collection
+          self::REST_RESOURCE
+        end
+
+        def resource_for_singular
+          self::REST_RESOURCE
+        end
+
+      end
+    end
+  end
+end

data/lib/quickbooks/model/custom_field.rb

@@ -0,0 +1,9 @@
+module Quickbooks
+  module Model
+    class CustomField < BaseModel
+      xml_accessor :id, :from => 'Id', :as => Integer
+      xml_accessor :name, :from => 'Name'
+      xml_accessor :type, :from => 'Type'
+    end
+  end
+end

data/lib/quickbooks/model/customer.rb

@@ -0,0 +1,118 @@
+# == Business Rules
+# * The DisplayName, GivenName, MiddleName, FamilyName, and PrintOnCheckName attributes must not contain a colon,":".
+# * The DisplayName attribute must be unique across all other customers, employees, vendors, and other names.
+# * The PrimaryEmailAddress attribute must contain an at sign, "@," and dot, ".".
+# * Nested customer objects can be used to define sub-customers, jobs, or a combination of both, under a parent.
+# * Up to four levels of nesting can be defined under a top-level customer object.
+# * The Job attribute defines whether the object is a top-level customer or nested sub-customer/job.
+# * Either the DisplayName attribute or at least one of Title, GivenName, MiddleName, FamilyName, Suffix, or FullyQualifiedName attributes are required during create.
+
+module Quickbooks
+  module Model
+    class Customer < BaseModel
+      XML_COLLECTION_NODE = "Customer"
+      XML_NODE = "Customer"
+      REST_RESOURCE = 'customer'
+
+      xml_name XML_NODE
+      xml_accessor :id, :from => 'Id', :as => Integer
+      xml_accessor :sync_token, :from => 'SyncToken', :as => Integer
+      xml_accessor :meta_data, :from => 'MetaData', :as => Quickbooks::Model::MetaData
+      xml_accessor :title, :from => 'Title'
+      xml_accessor :given_name, :from => 'GivenName'
+      xml_accessor :middle_name, :from => 'MiddleName'
+      xml_accessor :family_name, :from => 'FamilyName'
+      xml_accessor :company_name, :from => 'CompanyName'
+      xml_accessor :display_name, :from => 'DisplayName'
+      xml_accessor :print_on_check_name, :from => 'PrintOnCheckName'
+      xml_accessor :active, :from => 'Active'
+      xml_accessor :primary_phone, :from => 'PrimaryPhone', :as => Quickbooks::Model::TelephoneNumber
+      xml_accessor :alternate_phone, :from => 'AlternatePhone', :as => Quickbooks::Model::TelephoneNumber
+      xml_accessor :mobile_phone, :from => 'Mobile', :as => Quickbooks::Model::TelephoneNumber
+      xml_accessor :fax_phone, :from => 'Fax', :as => Quickbooks::Model::TelephoneNumber
+      xml_accessor :primary_email_address, :from => 'PrimaryEmailAddr', :as => Quickbooks::Model::EmailAddress
+      xml_accessor :web_site, :from => 'WebAddr', :as => Quickbooks::Model::WebSiteAddress
+      xml_accessor :billing_address, :from => 'BillAddr', :as => Quickbooks::Model::PhysicalAddress
+      xml_accessor :shipping_address, :from => 'ShipAddr', :as => Quickbooks::Model::PhysicalAddress
+      xml_accessor :job, :from => 'Job'
+      xml_accessor :bill_with_parent, :from => 'BillWithParent'
+      xml_accessor :parent_ref, :from => 'ParentRef', :as => Integer
+      xml_accessor :level, :from => 'Level'
+      xml_accessor :sales_term_ref, :from => 'SalesTermRef', :as => Integer
+      xml_accessor :payment_method_ref, :from => 'PaymentMethodRef'
+      xml_accessor :balance, :from => 'Balance', :as => Float
+      xml_accessor :open_balance_date, :from => 'OpenBalanceDate', :as => Date
+      xml_accessor :balance_with_jobs, :from => 'BalanceWithJobs', :as => Float
+      xml_accessor :preferred_delivery_method, :from => 'PreferredDeliveryMethod'
+      xml_accessor :resale_num, :from => 'ResaleNum'
+      xml_accessor :suffix, :from => 'Suffix'
+      xml_accessor :fully_qualified_name, :from => 'FullyQualifiedName'
+      xml_accessor :taxable, :from => 'Taxable'
+      xml_accessor :notes, :from => 'Notes'
+
+      validate :names_cannot_contain_invalid_characters
+      validate :email_address_is_valid
+
+      def active?
+        active.to_s == 'true'
+      end
+
+      def job?
+        job.to_s == 'true'
+      end
+
+      def bill_with_parent?
+        bill_with_parent.to_s == 'true'
+      end
+
+      def taxable?
+        taxable.to_s == 'true'
+      end
+
+      def valid_for_update?
+        if sync_token.nil?
+          errors.add(:sync_token, "Missing required attribute SyncToken for update")
+        end
+        errors.empty?
+      end
+
+      def valid_for_create?
+        valid?
+        errors.empty?
+      end
+
+      def email_address=(email_address)
+        self.primary_email_address = Quickbooks::Model::EmailAddress.new(email_address)
+      end
+
+      def email_address
+        primary_email_address
+      end
+
+      # 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
+      end
+
+      def names_cannot_contain_invalid_characters
+        [:display_name, :given_name, :middle_name, :family_name, :print_on_check_name].each do |property|
+          value = send(property).to_s
+          if value.index(':')
+            errors.add(property, ":#{property} cannot contain a colon (:).")
+          end
+        end
+      end
+
+      def email_address_is_valid
+        if primary_email_address
+          address = primary_email_address.address
+          unless address.index('@') && address.index('.')
+            errors.add(:primary_email_address, "Email address must contain @ and . (dot)")
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/quickbooks/model/customer_ref.rb

@@ -0,0 +1,21 @@
+module Quickbooks
+  module Model
+    class CustomerRef < BaseModel
+      xml_convention :camelcase
+      xml_accessor :name, :from => '@name' # Attribute with name 'name'
+      xml_accessor :value, :from => :content
+
+      def initialize(value = nil)
+        self.value = value
+      end
+
+      def to_i
+        self.value.to_i
+      end
+
+      def to_s
+        self.value.to_s
+      end
+    end
+  end
+end

data/lib/quickbooks/model/discount_override.rb

@@ -0,0 +1,15 @@
+module Quickbooks
+  module Model
+    class DiscountOverride < BaseModel
+      xml_accessor :discount_ref, :from => 'DiscountRef', :as => Integer
+      xml_accessor :percent_based, :from => 'PercentBased'
+      xml_accessor :discount_percent, :from => 'DiscountPercent', :as => Float
+      xml_accessor :discount_account_ref, :from => 'DiscountAccountRef', :as => Integer
+
+      def percent_based?
+        percent_based.to_s == 'true'
+      end
+
+    end
+  end
+end

data/lib/quickbooks/model/email_address.rb

@@ -0,0 +1,19 @@
+module Quickbooks
+  module Model
+    class EmailAddress < BaseModel
+      xml_accessor :address, :from => 'Address'
+
+      def to_xml(options = {})
+        return "" if address.to_s.empty?
+        super
+      end
+
+      def initialize(email_address = nil)
+        unless email_address.nil?
+          self.address = email_address
+        end
+      end
+
+    end
+  end
+end

data/lib/quickbooks/model/invoice.rb

@@ -0,0 +1,96 @@
+# == Business Rules
+# * An invoice must have at least one Line that describes an item.
+# * An invoice must have CustomerRef populated.
+# * The DocNumber attribute is populated automatically by the data service if not supplied.
+# * If ShipAddr, BillAddr, or both are not provided, the appropriate customer address from Customer is used to fill those values.
+# * DocNumber, if supplied, must be unique.
+
+module Quickbooks
+  module Model
+    class Invoice < BaseModel
+
+      #== Constants
+      REST_RESOURCE = 'invoice'
+      XML_COLLECTION_NODE = "Invoice"
+      XML_NODE = "Invoice"
+
+      xml_accessor :id, :from => 'Id', :as => Integer
+      xml_accessor :sync_token, :from => 'SyncToken', :as => Integer
+      xml_accessor :meta_data, :from => 'MetaData', :as => Quickbooks::Model::MetaData
+      xml_accessor :custom_fields, :from => 'CustomField', :as => [Quickbooks::Model::CustomField]
+      xml_accessor :doc_number, :from => 'DocNumber'
+      xml_accessor :txn_date, :from => 'TxnDate', :as => Date
+      xml_accessor :private_note, :from => 'PrivateNote'
+      xml_accessor :linked_transactions, :from => 'LinkedTxn', :as => [Quickbooks::Model::LinkedTransaction]
+      xml_accessor :line_items, :from => 'Line', :as => [Quickbooks::Model::InvoiceLineItem]
+      xml_accessor :txn_tax_detail, :from => 'TxnTaxDetail'
+      xml_accessor :customer_ref, :from => 'CustomerRef', :as => Quickbooks::Model::CustomerRef
+      xml_accessor :customer_memo, :from => 'CustomerMemo'
+      xml_accessor :billing_address, :from => 'BillAddr', :as => Quickbooks::Model::PhysicalAddress
+      xml_accessor :shipping_address, :from => 'ShipAddr', :as => Quickbooks::Model::PhysicalAddress
+      xml_accessor :class_ref, :from => 'ClassRef'
+      xml_accessor :sales_term_ref, :from => 'SalesTermRef', :as => Integer
+      xml_accessor :due_date, :from => 'DueDate', :as => Date
+      xml_accessor :ship_method_ref, :from => 'ShipMethodRef'
+      xml_accessor :ship_date, :from => 'ShipDate', :as => Date
+      xml_accessor :tracking_num, :from => 'TrackingNum'
+      xml_accessor :ar_account_ref, :from => 'ARAccountRef', :as => Integer
+      xml_accessor :total_amount, :from => 'TotalAmt', :as => Float
+      xml_accessor :apply_tax_after_discount, :from => 'ApplyTaxAfterDiscount'
+      xml_accessor :print_status, :from => 'PrintStatus'
+      xml_accessor :email_status, :from => 'EmailStatus'
+      xml_accessor :balance, :from => 'Balance', :as => Float
+      xml_accessor :deposit, :from => 'Deposit', :as => Float
+      xml_accessor :department_ref, :from => 'DepartmentRef'
+      xml_accessor :allow_ipn_payment, :from => 'AllowIPNPayment'
+      xml_accessor :allow_online_payment, :from => 'AllowOnlinePayment'
+      xml_accessor :allow_online_credit_card_payment, :from => 'AllowOnlineCreditCardPayment'
+      xml_accessor :allow_online_ach_payment, :from => 'AllowOnlineACHPayment'
+
+      #== Validations
+      validates_length_of :line_items, :minimum => 1
+      validate :existence_of_customer_ref
+
+      def initialize
+        ensure_line_items_initialization
+        super
+      end
+
+      def apply_tax_after_discount?
+        apply_tax_after_discount.to_s == 'true'
+      end
+
+      def allow_ipn_payment?
+        allow_ipn_payment.to_s == 'true'
+      end
+
+      def allow_online_payment?
+        allow_online_payment.to_s == 'true'
+      end
+
+      def allow_online_credit_card_payment?
+        allow_online_credit_card_payment.to_s == 'true'
+      end
+
+      def allow_online_ach_payment?
+        allow_online_ach_payment.to_s == 'true'
+      end
+
+      def customer_id=(customer_id)
+        self.customer_ref = Quickbooks::Model::CustomerRef.new(customer_id)
+      end
+
+      private
+
+      def existence_of_customer_ref
+        if customer_ref.nil? || (customer_ref && customer_ref.value == 0)
+          errors.add(:customer_ref, "CustomerRef is required and must be a non-zero value.")
+        end
+      end
+
+      def ensure_line_items_initialization
+        self.line_items ||= []
+      end
+    end
+  end
+end